paperlessmanager/docs/Paperless-ngx REST API.yaml

openapi: 3.0.3
info:
  title: Paperless-ngx REST API
  version: 6.0.0 (9)
  description: OpenAPI Spec for Paperless-ngx
paths:
  /api/bulk_edit_objects/:
    post:
      operationId: bulk_edit_objects
      description: Perform a bulk edit operation on a list of objects
      externalDocs:
        description: Further documentation
        url: https://docs.paperless-ngx.com/api/#objects
      tags:
      - bulk_edit_objects
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkEditObjectsRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkEditResult'
          description: ''
  /api/config/:
    get:
      operationId: config_list
      description: Get the application configuration
      externalDocs:
        description: Application Configuration
        url: https://docs.paperless-ngx.com/configuration/
      tags:
      - config
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApplicationConfiguration'
          description: ''
  /api/config/{id}/:
    get:
      operationId: config_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Paperless-ngx-Anwendungseinstellungen
          identifiziert.
        required: true
      tags:
      - config
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationConfiguration'
          description: ''
    put:
      operationId: config_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Paperless-ngx-Anwendungseinstellungen
          identifiziert.
        required: true
      tags:
      - config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationConfigurationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ApplicationConfigurationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ApplicationConfigurationRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationConfiguration'
          description: ''
    patch:
      operationId: config_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Paperless-ngx-Anwendungseinstellungen
          identifiziert.
        required: true
      tags:
      - config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedApplicationConfigurationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedApplicationConfigurationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedApplicationConfigurationRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationConfiguration'
          description: ''
    delete:
      operationId: config_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Paperless-ngx-Anwendungseinstellungen
          identifiziert.
        required: true
      tags:
      - config
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/correspondents/:
    get:
      operationId: correspondents_list
      parameters:
      - in: query
        name: full_perms
        schema:
          type: boolean
      - in: query
        name: id
        schema:
          type: integer
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: integer
        description: Mehrere Werte können durch Kommas getrennt sein.
        explode: false
        style: form
      - in: query
        name: name__icontains
        schema:
          type: string
      - in: query
        name: name__iendswith
        schema:
          type: string
      - in: query
        name: name__iexact
        schema:
          type: string
      - in: query
        name: name__istartswith
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - correspondents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCorrespondentList'
          description: ''
    post:
      operationId: correspondents_create
      tags:
      - correspondents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorrespondentRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CorrespondentRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CorrespondentRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Correspondent'
          description: ''
  /api/correspondents/{id}/:
    get:
      operationId: correspondents_retrieve
      parameters:
      - in: query
        name: full_perms
        schema:
          type: boolean
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Korrespondent identifiziert.
        required: true
      tags:
      - correspondents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Correspondent'
          description: ''
    put:
      operationId: correspondents_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Korrespondent identifiziert.
        required: true
      tags:
      - correspondents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorrespondentRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CorrespondentRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CorrespondentRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Correspondent'
          description: ''
    patch:
      operationId: correspondents_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Korrespondent identifiziert.
        required: true
      tags:
      - correspondents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCorrespondentRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCorrespondentRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCorrespondentRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Correspondent'
          description: ''
    delete:
      operationId: correspondents_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Korrespondent identifiziert.
        required: true
      tags:
      - correspondents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/custom_fields/:
    get:
      operationId: custom_fields_list
      parameters:
      - in: query
        name: id
        schema:
          type: integer
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: integer
        description: Mehrere Werte können durch Kommas getrennt sein.
        explode: false
        style: form
      - in: query
        name: name__icontains
        schema:
          type: string
      - in: query
        name: name__iendswith
        schema:
          type: string
      - in: query
        name: name__iexact
        schema:
          type: string
      - in: query
        name: name__istartswith
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - custom_fields
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCustomFieldList'
          description: ''
    post:
      operationId: custom_fields_create
      tags:
      - custom_fields
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFieldRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomFieldRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomFieldRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
          description: ''
  /api/custom_fields/{id}/:
    get:
      operationId: custom_fields_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Benutzerdefiniertes Feld identifiziert.
        required: true
      tags:
      - custom_fields
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
          description: ''
    put:
      operationId: custom_fields_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Benutzerdefiniertes Feld identifiziert.
        required: true
      tags:
      - custom_fields
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFieldRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomFieldRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomFieldRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
          description: ''
    patch:
      operationId: custom_fields_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Benutzerdefiniertes Feld identifiziert.
        required: true
      tags:
      - custom_fields
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCustomFieldRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCustomFieldRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCustomFieldRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
          description: ''
    delete:
      operationId: custom_fields_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Benutzerdefiniertes Feld identifiziert.
        required: true
      tags:
      - custom_fields
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/document_types/:
    get:
      operationId: document_types_list
      parameters:
      - in: query
        name: full_perms
        schema:
          type: boolean
      - in: query
        name: id
        schema:
          type: integer
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: integer
        description: Mehrere Werte können durch Kommas getrennt sein.
        explode: false
        style: form
      - in: query
        name: name__icontains
        schema:
          type: string
      - in: query
        name: name__iendswith
        schema:
          type: string
      - in: query
        name: name__iexact
        schema:
          type: string
      - in: query
        name: name__istartswith
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - document_types
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDocumentTypeList'
          description: ''
    post:
      operationId: document_types_create
      tags:
      - document_types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentTypeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DocumentTypeRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DocumentTypeRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentType'
          description: ''
  /api/document_types/{id}/:
    get:
      operationId: document_types_retrieve
      parameters:
      - in: query
        name: full_perms
        schema:
          type: boolean
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokumenttyp identifiziert.
        required: true
      tags:
      - document_types
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentType'
          description: ''
    put:
      operationId: document_types_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokumenttyp identifiziert.
        required: true
      tags:
      - document_types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentTypeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DocumentTypeRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DocumentTypeRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentType'
          description: ''
    patch:
      operationId: document_types_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokumenttyp identifiziert.
        required: true
      tags:
      - document_types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDocumentTypeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDocumentTypeRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDocumentTypeRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentType'
          description: ''
    delete:
      operationId: document_types_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokumenttyp identifiziert.
        required: true
      tags:
      - document_types
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/documents/:
    get:
      operationId: documents_list
      description: Document views including search
      parameters:
      - in: query
        name: added__date__gt
        schema:
          type: string
          format: date
      - in: query
        name: added__date__gte
        schema:
          type: string
          format: date
      - in: query
        name: added__date__lt
        schema:
          type: string
          format: date
      - in: query
        name: added__date__lte
        schema:
          type: string
          format: date
      - in: query
        name: added__day
        schema:
          type: number
      - in: query
        name: added__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: added__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: added__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: added__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: added__month
        schema:
          type: number
      - in: query
        name: added__year
        schema:
          type: number
      - in: query
        name: archive_serial_number
        schema:
          type: integer
      - in: query
        name: archive_serial_number__gt
        schema:
          type: integer
      - in: query
        name: archive_serial_number__gte
        schema:
          type: integer
      - in: query
        name: archive_serial_number__isnull
        schema:
          type: boolean
      - in: query
        name: archive_serial_number__lt
        schema:
          type: integer
      - in: query
        name: archive_serial_number__lte
        schema:
          type: integer
      - in: query
        name: checksum__icontains
        schema:
          type: string
      - in: query
        name: checksum__iendswith
        schema:
          type: string
      - in: query
        name: checksum__iexact
        schema:
          type: string
      - in: query
        name: checksum__istartswith
        schema:
          type: string
      - in: query
        name: content__icontains
        schema:
          type: string
      - in: query
        name: content__iendswith
        schema:
          type: string
      - in: query
        name: content__iexact
        schema:
          type: string
      - in: query
        name: content__istartswith
        schema:
          type: string
      - in: query
        name: correspondent__id
        schema:
          type: integer
      - in: query
        name: correspondent__id__in
        schema:
          type: array
          items:
            type: integer
        description: Mehrere Werte können durch Kommas getrennt sein.
        explode: false
        style: form
      - in: query
        name: correspondent__id__none
        schema:
          type: integer
      - in: query
        name: correspondent__isnull
        schema:
          type: boolean
      - in: query
        name: correspondent__name__icontains
        schema:
          type: string
      - in: query
        name: correspondent__name__iendswith
        schema:
          type: string
      - in: query
        name: correspondent__name__iexact
        schema:
          type: string
      - in: query
        name: correspondent__name__istartswith
        schema:
          type: string
      - in: query
        name: created__date__gt
        schema:
          type: string
          format: date
      - in: query
        name: created__date__gte
        schema:
          type: string
          format: date
      - in: query
        name: created__date__lt
        schema:
          type: string
          format: date
      - in: query
        name: created__date__lte
        schema:
          type: string
          format: date
      - in: query
        name: created__day
        schema:
          type: number
      - in: query
        name: created__gt
        schema:
          type: string
          format: date
      - in: query
        name: created__gte
        schema:
          type: string
          format: date
      - in: query
        name: created__lt
        schema:
          type: string
          format: date
      - in: query
        name: created__lte
        schema:
          type: string
          format: date
      - in: query
        name: created__month
        schema:
          type: number
      - in: query
        name: created__year
        schema:
          type: number
      - in: query
        name: custom_field_query
        schema:
          type: string
          minLength: 1
      - in: query
        name: custom_fields__icontains
        schema:
          type: string
          minLength: 1
      - in: query
        name: custom_fields__id__all
        schema:
          type: integer
      - in: query
        name: custom_fields__id__in
        schema:
          type: integer
      - in: query
        name: custom_fields__id__none
        schema:
          type: integer
      - in: query
        name: document_type__id
        schema:
          type: integer
      - in: query
        name: document_type__id__in
        schema:
          type: array
          items:
            type: integer
        description: Mehrere Werte können durch Kommas getrennt sein.
        explode: false
        style: form
      - in: query
        name: document_type__id__none
        schema:
          type: integer
      - in: query
        name: document_type__isnull
        schema:
          type: boolean
      - in: query
        name: document_type__name__icontains
        schema:
          type: string
      - in: query
        name: document_type__name__iendswith
        schema:
          type: string
      - in: query
        name: document_type__name__iexact
        schema:
          type: string
      - in: query
        name: document_type__name__istartswith
        schema:
          type: string
      - in: query
        name: fields
        schema:
          type: array
          items:
            type: string
      - in: query
        name: full_perms
        schema:
          type: boolean
      - in: query
        name: has_custom_fields
        schema:
          type: boolean
        description: Has custom field
      - in: query
        name: id
        schema:
          type: integer
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: integer
        description: Mehrere Werte können durch Kommas getrennt sein.
        explode: false
        style: form
      - in: query
        name: is_in_inbox
        schema:
          type: boolean
      - in: query
        name: is_tagged
        schema:
          type: boolean
        description: Is tagged
      - in: query
        name: mime_type
        schema:
          type: string
          title: MIME-Typ
      - in: query
        name: modified__date__gt
        schema:
          type: string
          format: date
      - in: query
        name: modified__date__gte
        schema:
          type: string
          format: date
      - in: query
        name: modified__date__lt
        schema:
          type: string
          format: date
      - in: query
        name: modified__date__lte
        schema:
          type: string
          format: date
      - in: query
        name: modified__day
        schema:
          type: number
      - in: query
        name: modified__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: modified__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: modified__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: modified__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: modified__month
        schema:
          type: number
      - in: query
        name: modified__year
        schema:
          type: number
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - in: query
        name: original_filename__icontains
        schema:
          type: string
      - in: query
        name: original_filename__iendswith
        schema:
          type: string
      - in: query
        name: original_filename__iexact
        schema:
          type: string
      - in: query
        name: original_filename__istartswith
        schema:
          type: string
      - in: query
        name: owner__id
        schema:
          type: integer
      - in: query
        name: owner__id__in
        schema:
          type: array
          items:
            type: integer
        description: Mehrere Werte können durch Kommas getrennt sein.
        explode: false
        style: form
      - in: query
        name: owner__id__none
        schema:
          type: integer
      - in: query
        name: owner__isnull
        schema:
          type: boolean
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      - in: query
        name: query
        schema:
          type: string
        description: Advanced search query string
      - name: search
        required: false
        in: query
        description: Ein Suchbegriff.
        schema:
          type: string
      - in: query
        name: shared_by__id
        schema:
          type: boolean
      - in: query
        name: storage_path__id
        schema:
          type: integer
      - in: query
        name: storage_path__id__in
        schema:
          type: array
          items:
            type: integer
        description: Mehrere Werte können durch Kommas getrennt sein.
        explode: false
        style: form
      - in: query
        name: storage_path__id__none
        schema:
          type: integer
      - in: query
        name: storage_path__isnull
        schema:
          type: boolean
      - in: query
        name: storage_path__name__icontains
        schema:
          type: string
      - in: query
        name: storage_path__name__iendswith
        schema:
          type: string
      - in: query
        name: storage_path__name__iexact
        schema:
          type: string
      - in: query
        name: storage_path__name__istartswith
        schema:
          type: string
      - in: query
        name: tags__id
        schema:
          type: integer
      - in: query
        name: tags__id__all
        schema:
          type: integer
      - in: query
        name: tags__id__in
        schema:
          type: integer
      - in: query
        name: tags__id__none
        schema:
          type: integer
      - in: query
        name: tags__name__icontains
        schema:
          type: string
      - in: query
        name: tags__name__iendswith
        schema:
          type: string
      - in: query
        name: tags__name__iexact
        schema:
          type: string
      - in: query
        name: tags__name__istartswith
        schema:
          type: string
      - in: query
        name: title__icontains
        schema:
          type: string
      - in: query
        name: title__iendswith
        schema:
          type: string
      - in: query
        name: title__iexact
        schema:
          type: string
      - in: query
        name: title__istartswith
        schema:
          type: string
      - in: query
        name: title_content
        schema:
          type: string
          minLength: 1
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDocumentList'
          description: ''
  /api/documents/{id}/:
    get:
      operationId: documents_retrieve
      description: Retrieve a single document
      parameters:
      - in: query
        name: fields
        schema:
          type: array
          items:
            type: string
      - in: query
        name: full_perms
        schema:
          type: boolean
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
          description: ''
        '400':
          description: No response body
    put:
      operationId: documents_update
      description: Pass a user object to serializer
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DocumentRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DocumentRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
          description: ''
    patch:
      operationId: documents_partial_update
      description: Pass a user object to serializer
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDocumentRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDocumentRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDocumentRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
          description: ''
    delete:
      operationId: documents_destroy
      description: Pass a user object to serializer
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/documents/{id}/download/:
    get:
      operationId: documents_download_retrieve
      description: Download the document
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      - in: query
        name: original
        schema:
          type: boolean
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
                format: binary
          description: ''
  /api/documents/{id}/email/:
    post:
      operationId: documents_email_create
      description: Email the document to one or more recipients as an attachment.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailDocumentRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EmailDocumentRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EmailDocumentRequestRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      deprecated: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDocumentResponse'
          description: ''
        '400':
          description: No response body
        '403':
          description: No response body
        '404':
          description: No response body
        '500':
          description: No response body
  /api/documents/{id}/history/:
    get:
      operationId: documents_history_list
      description: View the document history
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedLogEntryList'
          description: ''
        '400':
          description: No response body
        '403':
          description: No response body
        '404':
          description: No response body
  /api/documents/{id}/metadata/:
    get:
      operationId: documents_metadata_retrieve
      description: View the document metadata
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
        '400':
          description: No response body
        '403':
          description: No response body
        '404':
          description: No response body
  /api/documents/{id}/notes/:
    get:
      operationId: documents_notes_list
      description: View, add, or delete notes for the document
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      - in: query
        name: id
        schema:
          type: integer
        description: Note ID to delete (used only for DELETE requests)
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNotesList'
          description: ''
        '400':
          description: No response body
        '403':
          description: No response body
        '404':
          description: No response body
    post:
      operationId: documents_notes_create
      description: View, add, or delete notes for the document
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      - in: query
        name: id
        schema:
          type: integer
        description: Note ID to delete (used only for DELETE requests)
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoteCreateRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NoteCreateRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NoteCreateRequestRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNotesList'
          description: ''
        '400':
          description: No response body
        '403':
          description: No response body
        '404':
          description: No response body
    delete:
      operationId: documents_notes_destroy
      description: View, add, or delete notes for the document
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      - in: query
        name: id
        schema:
          type: integer
        description: Note ID to delete (used only for DELETE requests)
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNotesList'
          description: ''
        '400':
          description: No response body
        '403':
          description: No response body
        '404':
          description: No response body
  /api/documents/{id}/preview/:
    get:
      operationId: documents_preview_retrieve
      description: View the document preview
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
                format: binary
          description: ''
  /api/documents/{id}/share_links/:
    get:
      operationId: document_share_links
      description: View share links for the document
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    created:
                      type: string
                      format: date-time
                    expiration:
                      type: string
                      format: date-time
                    slug:
                      type: string
          description: ''
        '400':
          description: No response body
        '403':
          description: No response body
        '404':
          description: No response body
  /api/documents/{id}/suggestions/:
    get:
      operationId: documents_suggestions_retrieve
      description: View suggestions for the document
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Suggestions'
          description: ''
        '400':
          description: No response body
        '403':
          description: No response body
        '404':
          description: No response body
  /api/documents/{id}/thumb/:
    get:
      operationId: documents_thumb_retrieve
      description: View the document thumbnail
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Dokument identifiziert.
        required: true
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
                format: binary
          description: ''
  /api/documents/bulk_download/:
    post:
      operationId: documents_bulk_download_create
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkDownloadRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkDownload'
          description: ''
  /api/documents/bulk_edit/:
    post:
      operationId: bulk_edit
      description: Perform a bulk edit operation on a list of documents
      externalDocs:
        description: Further documentation
        url: https://docs.paperless-ngx.com/api/#bulk-editing
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkEditRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkEditDocumentsResult'
          description: ''
  /api/documents/email/:
    post:
      operationId: email_documents
      description: Email one or more documents as attachments to one or more recipients.
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EmailRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EmailRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDocumentsResponse'
          description: ''
        '400':
          description: No response body
        '403':
          description: No response body
        '404':
          description: No response body
        '500':
          description: No response body
  /api/documents/next_asn/:
    get:
      operationId: documents_next_asn_retrieve
      description: Get the next available Archive Serial Number (ASN) for a new document
      tags:
      - documents
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: integer
          description: ''
  /api/documents/post_document/:
    post:
      operationId: documents_post_document_create
      description: Upload a document via the API
      externalDocs:
        description: Further documentation
        url: https://docs.paperless-ngx.com/api/#file-uploads
      tags:
      - documents
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PostDocumentRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: ''
  /api/documents/selection_data/:
    post:
      operationId: documents_selection_data_create
      description: Get selection data for the selected documents
      tags:
      - documents
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DocumentListRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentListRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectionData'
          description: ''
  /api/groups/:
    get:
      operationId: groups_list
      parameters:
      - in: query
        name: name__icontains
        schema:
          type: string
      - in: query
        name: name__iendswith
        schema:
          type: string
      - in: query
        name: name__iexact
        schema:
          type: string
      - in: query
        name: name__istartswith
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - groups
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGroupList'
          description: ''
    post:
      operationId: groups_create
      tags:
      - groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GroupRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
  /api/groups/{id}/:
    get:
      operationId: groups_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Gruppe identifiziert.
        required: true
      tags:
      - groups
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
    put:
      operationId: groups_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Gruppe identifiziert.
        required: true
      tags:
      - groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GroupRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
    patch:
      operationId: groups_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Gruppe identifiziert.
        required: true
      tags:
      - groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedGroupRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedGroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedGroupRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
    delete:
      operationId: groups_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Gruppe identifiziert.
        required: true
      tags:
      - groups
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/logs/:
    get:
      operationId: logs_list
      description: Logs view
      tags:
      - logs
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
          description: ''
  /api/logs/{id}/:
    get:
      operationId: retrieve_log
      description: Single log view
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      - in: query
        name: limit
        schema:
          type: integer
        description: Return only the last N entries from the log file
      tags:
      - logs
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
          description: ''
        '404':
          description: No response body
  /api/mail_accounts/:
    get:
      operationId: mail_accounts_list
      parameters:
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - mail_accounts
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedMailAccountList'
          description: ''
    post:
      operationId: mail_accounts_create
      tags:
      - mail_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailAccount'
          description: ''
  /api/mail_accounts/{id}/:
    get:
      operationId: mail_accounts_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der E-Mail-Konto identifiziert.
        required: true
      tags:
      - mail_accounts
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailAccount'
          description: ''
    put:
      operationId: mail_accounts_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der E-Mail-Konto identifiziert.
        required: true
      tags:
      - mail_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailAccount'
          description: ''
    patch:
      operationId: mail_accounts_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der E-Mail-Konto identifiziert.
        required: true
      tags:
      - mail_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMailAccountRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMailAccountRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMailAccountRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailAccount'
          description: ''
    delete:
      operationId: mail_accounts_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der E-Mail-Konto identifiziert.
        required: true
      tags:
      - mail_accounts
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/mail_accounts/{id}/process/:
    post:
      operationId: mail_account_process
      description: Manually process the selected mail account for new messages.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der E-Mail-Konto identifiziert.
        required: true
      tags:
      - mail_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailAccountProcessResponse'
          description: ''
        '404':
          description: No response body
  /api/mail_accounts/test/:
    post:
      operationId: mail_account_test
      description: Test a mail account
      tags:
      - mail_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MailAccountRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailAccountTestResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: string
          description: ''
  /api/mail_rules/:
    get:
      operationId: mail_rules_list
      parameters:
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - mail_rules
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedMailRuleList'
          description: ''
    post:
      operationId: mail_rules_create
      tags:
      - mail_rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailRuleRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MailRuleRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MailRuleRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailRule'
          description: ''
  /api/mail_rules/{id}/:
    get:
      operationId: mail_rules_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der E-Mail-Regel identifiziert.
        required: true
      tags:
      - mail_rules
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailRule'
          description: ''
    put:
      operationId: mail_rules_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der E-Mail-Regel identifiziert.
        required: true
      tags:
      - mail_rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailRuleRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MailRuleRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MailRuleRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailRule'
          description: ''
    patch:
      operationId: mail_rules_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der E-Mail-Regel identifiziert.
        required: true
      tags:
      - mail_rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMailRuleRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMailRuleRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMailRuleRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailRule'
          description: ''
    delete:
      operationId: mail_rules_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der E-Mail-Regel identifiziert.
        required: true
      tags:
      - mail_rules
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/oauth/callback/:
    get:
      operationId: oauth_callback_retrieve
      description: Callback view for OAuth2 authentication
      tags:
      - oauth
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          description: No response body
  /api/processed_mail/:
    get:
      operationId: processed_mail_list
      parameters:
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      - in: query
        name: rule
        schema:
          type: integer
      - in: query
        name: status
        schema:
          type: string
      tags:
      - processed_mail
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedProcessedMailList'
          description: ''
  /api/processed_mail/{id}/:
    get:
      operationId: processed_mail_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der processed mail identifiziert.
        required: true
      tags:
      - processed_mail
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessedMail'
          description: ''
  /api/processed_mail/bulk_delete/:
    post:
      operationId: processed_mail_bulk_delete_create
      tags:
      - processed_mail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessedMailRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ProcessedMailRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ProcessedMailRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessedMail'
          description: ''
  /api/profile/:
    get:
      operationId: profile_retrieve
      description: User profile view, only available when logged in
      tags:
      - profile
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
          description: ''
    patch:
      operationId: profile_partial_update
      description: User profile view, only available when logged in
      tags:
      - profile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedProfileRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedProfileRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedProfileRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
          description: ''
  /api/profile/disconnect_social_account/:
    post:
      operationId: profile_disconnect_social_account_create
      description: Disconnects a social account provider from the user account
      tags:
      - profile
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
              required:
              - id
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: integer
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: string
          description: ''
  /api/profile/generate_auth_token/:
    post:
      operationId: profile_generate_auth_token_create
      description: |-
        Generates (or re-generates) an auth token, requires a logged in user
        unlike the default DRF endpoint
      tags:
      - profile
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: ''
  /api/profile/social_account_providers/:
    get:
      operationId: profile_social_account_providers_retrieve
      description: List of social account providers
      tags:
      - profile
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/profile/totp/:
    get:
      operationId: profile_totp_retrieve
      description: Generates a new TOTP secret and returns the URL and SVG
      tags:
      - profile
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
    post:
      operationId: profile_totp_create
      description: Validates a TOTP code and activates the TOTP authenticator
      tags:
      - profile
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                secret:
                  type: string
                code:
                  type: string
              required:
              - secret
              - code
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
    delete:
      operationId: profile_totp_destroy
      description: Deactivates the TOTP authenticator
      tags:
      - profile
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: boolean
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: string
          description: ''
  /api/remote_version/:
    get:
      operationId: remote_version_retrieve
      description: Get the current version of the Paperless-NGX server
      tags:
      - remote_version
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/saved_views/:
    get:
      operationId: saved_views_list
      parameters:
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - saved_views
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSavedViewList'
          description: ''
    post:
      operationId: saved_views_create
      tags:
      - saved_views
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SavedViewRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SavedViewRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SavedViewRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedView'
          description: ''
  /api/saved_views/{id}/:
    get:
      operationId: saved_views_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Gespeicherte Ansicht identifiziert.
        required: true
      tags:
      - saved_views
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedView'
          description: ''
    put:
      operationId: saved_views_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Gespeicherte Ansicht identifiziert.
        required: true
      tags:
      - saved_views
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SavedViewRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SavedViewRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SavedViewRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedView'
          description: ''
    patch:
      operationId: saved_views_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Gespeicherte Ansicht identifiziert.
        required: true
      tags:
      - saved_views
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSavedViewRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSavedViewRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSavedViewRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedView'
          description: ''
    delete:
      operationId: saved_views_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Gespeicherte Ansicht identifiziert.
        required: true
      tags:
      - saved_views
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/search/:
    get:
      operationId: search_retrieve
      description: Global search
      parameters:
      - in: query
        name: db_only
        schema:
          type: boolean
        description: Search only the database
      - in: query
        name: query
        schema:
          type: string
        description: Query to search for
        required: true
      tags:
      - search
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResult'
          description: ''
  /api/search/autocomplete/:
    get:
      operationId: search_autocomplete_list
      description: Get a list of all available tags
      parameters:
      - in: query
        name: limit
        schema:
          type: integer
        description: Number of completions to return
      - in: query
        name: term
        schema:
          type: string
        description: Term to search for
      tags:
      - search
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
          description: ''
  /api/share_links/:
    get:
      operationId: share_links_list
      parameters:
      - in: query
        name: created__date__gt
        schema:
          type: string
          format: date
      - in: query
        name: created__date__gte
        schema:
          type: string
          format: date
      - in: query
        name: created__date__lt
        schema:
          type: string
          format: date
      - in: query
        name: created__date__lte
        schema:
          type: string
          format: date
      - in: query
        name: created__day
        schema:
          type: number
      - in: query
        name: created__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: created__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: created__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: created__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: created__month
        schema:
          type: number
      - in: query
        name: created__year
        schema:
          type: number
      - in: query
        name: expiration__date__gt
        schema:
          type: string
          format: date
      - in: query
        name: expiration__date__gte
        schema:
          type: string
          format: date
      - in: query
        name: expiration__date__lt
        schema:
          type: string
          format: date
      - in: query
        name: expiration__date__lte
        schema:
          type: string
          format: date
      - in: query
        name: expiration__day
        schema:
          type: number
      - in: query
        name: expiration__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: expiration__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: expiration__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: expiration__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: expiration__month
        schema:
          type: number
      - in: query
        name: expiration__year
        schema:
          type: number
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - share_links
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedShareLinkList'
          description: ''
    post:
      operationId: share_links_create
      tags:
      - share_links
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareLinkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ShareLinkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ShareLinkRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareLink'
          description: ''
  /api/share_links/{id}/:
    get:
      operationId: share_links_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Freigabelink identifiziert.
        required: true
      tags:
      - share_links
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareLink'
          description: ''
    put:
      operationId: share_links_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Freigabelink identifiziert.
        required: true
      tags:
      - share_links
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareLinkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ShareLinkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ShareLinkRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareLink'
          description: ''
    patch:
      operationId: share_links_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Freigabelink identifiziert.
        required: true
      tags:
      - share_links
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedShareLinkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedShareLinkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedShareLinkRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareLink'
          description: ''
    delete:
      operationId: share_links_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Freigabelink identifiziert.
        required: true
      tags:
      - share_links
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/statistics/:
    get:
      operationId: statistics_retrieve
      description: Get statistics for the current user
      tags:
      - statistics
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/status/:
    get:
      operationId: status_retrieve
      description: Get the current system status of the Paperless-NGX server
      tags:
      - status
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemStatus'
          description: ''
  /api/storage_paths/:
    get:
      operationId: storage_paths_list
      parameters:
      - in: query
        name: full_perms
        schema:
          type: boolean
      - in: query
        name: id
        schema:
          type: integer
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: integer
        description: Mehrere Werte können durch Kommas getrennt sein.
        explode: false
        style: form
      - in: query
        name: name__icontains
        schema:
          type: string
      - in: query
        name: name__iendswith
        schema:
          type: string
      - in: query
        name: name__iexact
        schema:
          type: string
      - in: query
        name: name__istartswith
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      - in: query
        name: path__icontains
        schema:
          type: string
      - in: query
        name: path__iendswith
        schema:
          type: string
      - in: query
        name: path__iexact
        schema:
          type: string
      - in: query
        name: path__istartswith
        schema:
          type: string
      tags:
      - storage_paths
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedStoragePathList'
          description: ''
    post:
      operationId: storage_paths_create
      tags:
      - storage_paths
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoragePathRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/StoragePathRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/StoragePathRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoragePath'
          description: ''
  /api/storage_paths/{id}/:
    get:
      operationId: storage_paths_retrieve
      parameters:
      - in: query
        name: full_perms
        schema:
          type: boolean
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Speicherpfad identifiziert.
        required: true
      tags:
      - storage_paths
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoragePath'
          description: ''
    put:
      operationId: storage_paths_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Speicherpfad identifiziert.
        required: true
      tags:
      - storage_paths
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoragePathRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/StoragePathRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/StoragePathRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoragePath'
          description: ''
    patch:
      operationId: storage_paths_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Speicherpfad identifiziert.
        required: true
      tags:
      - storage_paths
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedStoragePathRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedStoragePathRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedStoragePathRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoragePath'
          description: ''
    delete:
      operationId: storage_paths_destroy
      description: |-
        When a storage path is deleted, see if documents
        using it require a rename/move
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Speicherpfad identifiziert.
        required: true
      tags:
      - storage_paths
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/storage_paths/test/:
    post:
      operationId: storage_paths_test_create
      description: Test storage path against a document
      tags:
      - storage_paths
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoragePathRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/StoragePathRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/StoragePathRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoragePath'
          description: ''
  /api/tags/:
    get:
      operationId: tags_list
      description: Build a children map once to avoid per-parent queries in the serializer.
      parameters:
      - in: query
        name: full_perms
        schema:
          type: boolean
      - in: query
        name: id
        schema:
          type: integer
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: integer
        description: Mehrere Werte können durch Kommas getrennt sein.
        explode: false
        style: form
      - in: query
        name: is_root
        schema:
          type: boolean
        description: Is root tag
      - in: query
        name: name__icontains
        schema:
          type: string
      - in: query
        name: name__iendswith
        schema:
          type: string
      - in: query
        name: name__iexact
        schema:
          type: string
      - in: query
        name: name__istartswith
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - tags
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTagList'
          description: ''
    post:
      operationId: tags_create
      tags:
      - tags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TagRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TagRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: ''
  /api/tags/{id}/:
    get:
      operationId: tags_retrieve
      parameters:
      - in: query
        name: full_perms
        schema:
          type: boolean
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Tag identifiziert.
        required: true
      tags:
      - tags
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: ''
    put:
      operationId: tags_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Tag identifiziert.
        required: true
      tags:
      - tags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TagRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TagRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: ''
    patch:
      operationId: tags_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Tag identifiziert.
        required: true
      tags:
      - tags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedTagRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedTagRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedTagRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: ''
    delete:
      operationId: tags_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Tag identifiziert.
        required: true
      tags:
      - tags
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/tasks/:
    get:
      operationId: tasks_list
      parameters:
      - in: query
        name: acknowledged
        schema:
          type: boolean
        description: Acknowledged
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - in: query
        name: status
        schema:
          type: string
          title: Aufgabenstatus
          enum:
          - FAILURE
          - PENDING
          - RECEIVED
          - RETRY
          - REVOKED
          - STARTED
          - SUCCESS
        description: |-
          Aktueller Status der laufenden Aufgabe

          * `FAILURE` - FAILURE
          * `PENDING` - PENDING
          * `RECEIVED` - RECEIVED
          * `RETRY` - RETRY
          * `REVOKED` - REVOKED
          * `STARTED` - STARTED
          * `SUCCESS` - SUCCESS
      - in: query
        name: task_id
        schema:
          type: string
        description: Filter tasks by Celery UUID
      - in: query
        name: task_name
        schema:
          type: string
          nullable: true
          title: Aufgabenname
          enum:
          - check_sanity
          - consume_file
          - index_optimize
          - train_classifier
        description: |-
          Name der ausgeführten Aufgabe

          * `consume_file` - Datei verarbeiten
          * `train_classifier` - Klassifikator trainieren
          * `check_sanity` - Plausibilität prüfen
          * `index_optimize` - Indexoptimierung
      - in: query
        name: type
        schema:
          type: string
          title: Aufgabentyp
          enum:
          - auto_task
          - manual_task
          - scheduled_task
        description: |-
          Art der ausgeführten Aufgabe

          * `auto_task` - Automatische Aufgabe
          * `scheduled_task` - Geplante Aufgabe
          * `manual_task` - Manuelle Aufgabe
      tags:
      - tasks
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TasksView'
          description: ''
  /api/tasks/{id}/:
    get:
      operationId: tasks_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der paperless task identifiziert.
        required: true
      - in: query
        name: task_id
        schema:
          type: string
        description: Filter tasks by Celery UUID
      tags:
      - tasks
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksView'
          description: ''
  /api/tasks/acknowledge/:
    post:
      operationId: acknowledge_tasks
      description: Acknowledge a list of tasks
      parameters:
      - in: query
        name: task_id
        schema:
          type: string
        description: Filter tasks by Celery UUID
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tasks:
                  type: array
                  items:
                    type: integer
              required:
              - tasks
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcknowledgeTasks'
          description: ''
        '400':
          description: No response body
  /api/tasks/run/:
    post:
      operationId: tasks_run_create
      parameters:
      - in: query
        name: task_id
        schema:
          type: string
        description: Filter tasks by Celery UUID
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TasksViewRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TasksViewRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TasksViewRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TasksView'
          description: ''
  /api/token/:
    post:
      operationId: token_create
      tags:
      - token
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PaperlessAuthTokenRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PaperlessAuthTokenRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/PaperlessAuthTokenRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaperlessAuthToken'
          description: ''
  /api/trash/:
    get:
      operationId: trash_list
      parameters:
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - trash
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          description: No response body
    post:
      operationId: trash_create
      tags:
      - trash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrashRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TrashRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TrashRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          description: No response body
  /api/ui_settings/:
    get:
      operationId: ui_settings_retrieve
      tags:
      - ui_settings
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UiSettingsView'
          description: ''
    post:
      operationId: ui_settings_create
      tags:
      - ui_settings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UiSettingsViewRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UiSettingsViewRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UiSettingsViewRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UiSettingsView'
          description: ''
  /api/users/:
    get:
      operationId: users_list
      parameters:
      - name: ordering
        required: false
        in: query
        description: Feld, das zum Sortieren der Ergebnisse verwendet werden soll.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      - in: query
        name: username__icontains
        schema:
          type: string
      - in: query
        name: username__iendswith
        schema:
          type: string
      - in: query
        name: username__iexact
        schema:
          type: string
      - in: query
        name: username__istartswith
        schema:
          type: string
      tags:
      - users
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedUserList'
          description: ''
    post:
      operationId: users_create
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: ''
  /api/users/{id}/:
    get:
      operationId: users_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Benutzer identifiziert.
        required: true
      tags:
      - users
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: ''
    put:
      operationId: users_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Benutzer identifiziert.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: ''
    patch:
      operationId: users_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Benutzer identifiziert.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedUserRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedUserRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedUserRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: ''
    delete:
      operationId: users_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Benutzer identifiziert.
        required: true
      tags:
      - users
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/users/{id}/deactivate_totp/:
    post:
      operationId: users_deactivate_totp_create
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Benutzer identifiziert.
        required: true
      tags:
      - users
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: boolean
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: string
          description: ''
  /api/workflow_actions/:
    get:
      operationId: workflow_actions_list
      parameters:
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - workflow_actions
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWorkflowActionList'
          description: ''
    post:
      operationId: workflow_actions_create
      tags:
      - workflow_actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowActionRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WorkflowActionRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WorkflowActionRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowAction'
          description: ''
  /api/workflow_actions/{id}/:
    get:
      operationId: workflow_actions_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Arbeitsablauf-Aktion identifiziert.
        required: true
      tags:
      - workflow_actions
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowAction'
          description: ''
    put:
      operationId: workflow_actions_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Arbeitsablauf-Aktion identifiziert.
        required: true
      tags:
      - workflow_actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowActionRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WorkflowActionRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WorkflowActionRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowAction'
          description: ''
    patch:
      operationId: workflow_actions_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Arbeitsablauf-Aktion identifiziert.
        required: true
      tags:
      - workflow_actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWorkflowActionRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedWorkflowActionRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedWorkflowActionRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowAction'
          description: ''
    delete:
      operationId: workflow_actions_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Arbeitsablauf-Aktion identifiziert.
        required: true
      tags:
      - workflow_actions
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/workflow_triggers/:
    get:
      operationId: workflow_triggers_list
      parameters:
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - workflow_triggers
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWorkflowTriggerList'
          description: ''
    post:
      operationId: workflow_triggers_create
      tags:
      - workflow_triggers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowTriggerRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WorkflowTriggerRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WorkflowTriggerRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTrigger'
          description: ''
  /api/workflow_triggers/{id}/:
    get:
      operationId: workflow_triggers_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Arbeitsablauf-Auslöser identifiziert.
        required: true
      tags:
      - workflow_triggers
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTrigger'
          description: ''
    put:
      operationId: workflow_triggers_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Arbeitsablauf-Auslöser identifiziert.
        required: true
      tags:
      - workflow_triggers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowTriggerRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WorkflowTriggerRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WorkflowTriggerRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTrigger'
          description: ''
    patch:
      operationId: workflow_triggers_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Arbeitsablauf-Auslöser identifiziert.
        required: true
      tags:
      - workflow_triggers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWorkflowTriggerRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedWorkflowTriggerRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedWorkflowTriggerRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTrigger'
          description: ''
    delete:
      operationId: workflow_triggers_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der Arbeitsablauf-Auslöser identifiziert.
        required: true
      tags:
      - workflow_triggers
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/workflows/:
    get:
      operationId: workflows_list
      parameters:
      - name: page
        required: false
        in: query
        description: Eine Seitenzahl in der paginierten Ergebnismenge.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Anzahl der pro Seite zurückzugebenden Ergebnisse.
        schema:
          type: integer
      tags:
      - workflows
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWorkflowList'
          description: ''
    post:
      operationId: workflows_create
      tags:
      - workflows
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WorkflowRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WorkflowRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
          description: ''
  /api/workflows/{id}/:
    get:
      operationId: workflows_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der workflow identifiziert.
        required: true
      tags:
      - workflows
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
          description: ''
    put:
      operationId: workflows_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der workflow identifiziert.
        required: true
      tags:
      - workflows
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WorkflowRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WorkflowRequest'
        required: true
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
          description: ''
    patch:
      operationId: workflows_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der workflow identifiziert.
        required: true
      tags:
      - workflows
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWorkflowRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedWorkflowRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedWorkflowRequest'
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
          description: ''
    delete:
      operationId: workflows_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: Ein eindeutiger Ganzzahl-Wert, der workflow identifiziert.
        required: true
      tags:
      - workflows
      security:
      - PaperelessBasicAuthentication: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
components:
  schemas:
    AccountTypeEnum:
      enum:
      - 1
      - 2
      - 3
      type: integer
      description: |-
        * `1` - IMAP
        * `2` - Gmail-OAuth
        * `3` - Outlook-OAuth
    AcknowledgeTasks:
      type: object
      properties:
        result:
          type: integer
      required:
      - result
    Actor:
      type: object
      properties:
        id:
          type: integer
        username:
          type: string
      required:
      - id
      - username
    ApplicationConfiguration:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        user_args:
          nullable: true
        barcode_tag_mapping:
          nullable: true
        output_type:
          nullable: true
          title: Legt den PDF-Typ der Ausgabedatei fest
          oneOf:
          - $ref: '#/components/schemas/OutputTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        pages:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: OCR von Seite 1 bis zu diesem Wert durchführen
        language:
          type: string
          nullable: true
          title: OCR für diese Sprachen durchführen
          maxLength: 32
        mode:
          nullable: true
          title: Legt den OCR-Modus fest
          oneOf:
          - $ref: '#/components/schemas/ModeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        skip_archive_file:
          nullable: true
          title: Steuert die Erzeugung einer Archivdatei
          oneOf:
          - $ref: '#/components/schemas/SkipArchiveFileEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        image_dpi:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Setzt den Bild-DPI Fallback-Wert
        unpaper_clean:
          nullable: true
          title: Steuert die unpaper-Bereinigung
          oneOf:
          - $ref: '#/components/schemas/UnpaperCleanEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        deskew:
          type: boolean
          nullable: true
          title: Aktiviert die Schräglagenkorrektur
        rotate_pages:
          type: boolean
          nullable: true
          title: Aktiviert Seitenrotation
        rotate_pages_threshold:
          type: number
          format: double
          minimum: 0.0
          nullable: true
          title: Legt die Schwelle für die Seitenrotation fest
        max_image_pixels:
          type: number
          format: double
          minimum: 0.0
          nullable: true
          title: Legt die maximale Bildgröße für die Dekomprimierung fest
        color_conversion_strategy:
          nullable: true
          title: Legt die Ghostscript-Farbkonvertierungsstrategie fest
          oneOf:
          - $ref: '#/components/schemas/ColorConversionStrategyEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        app_title:
          type: string
          nullable: true
          title: Anwendungstitel
          maxLength: 48
        app_logo:
          type: string
          format: uri
          nullable: true
          title: Anwendungslogo
          pattern: (?:jpg|png|gif|svg)$
        barcodes_enabled:
          type: boolean
          nullable: true
          title: Aktiviert Barcode-Scan
        barcode_enable_tiff_support:
          type: boolean
          nullable: true
          title: Aktiviert Barcode-TIFF-Unterstützung
        barcode_string:
          type: string
          nullable: true
          title: Legt die Barcode-Zeichenkette fest
          maxLength: 32
        barcode_retain_split_pages:
          type: boolean
          nullable: true
          title: Behält geteilte Seiten
        barcode_enable_asn:
          type: boolean
          nullable: true
          title: Aktiviert ASN-Barcode
        barcode_asn_prefix:
          type: string
          nullable: true
          title: Legt den ASN-Barcodepräfix fest
          maxLength: 32
        barcode_upscale:
          type: number
          format: double
          minimum: 1.0
          nullable: true
          title: Legt den Barcode-Hochskalierungsfaktor fest
        barcode_dpi:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Legt die Barcode-DPI fest
        barcode_max_pages:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Legt die maximale Anzahl an Seiten für Barcodes fest
        barcode_enable_tag:
          type: boolean
          nullable: true
          title: Aktiviert Tag-Barcode
      required:
      - barcode_tag_mapping
      - id
      - user_args
    ApplicationConfigurationRequest:
      type: object
      properties:
        user_args:
          nullable: true
        barcode_tag_mapping:
          nullable: true
        output_type:
          nullable: true
          title: Legt den PDF-Typ der Ausgabedatei fest
          oneOf:
          - $ref: '#/components/schemas/OutputTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        pages:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: OCR von Seite 1 bis zu diesem Wert durchführen
        language:
          type: string
          nullable: true
          title: OCR für diese Sprachen durchführen
          maxLength: 32
        mode:
          nullable: true
          title: Legt den OCR-Modus fest
          oneOf:
          - $ref: '#/components/schemas/ModeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        skip_archive_file:
          nullable: true
          title: Steuert die Erzeugung einer Archivdatei
          oneOf:
          - $ref: '#/components/schemas/SkipArchiveFileEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        image_dpi:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Setzt den Bild-DPI Fallback-Wert
        unpaper_clean:
          nullable: true
          title: Steuert die unpaper-Bereinigung
          oneOf:
          - $ref: '#/components/schemas/UnpaperCleanEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        deskew:
          type: boolean
          nullable: true
          title: Aktiviert die Schräglagenkorrektur
        rotate_pages:
          type: boolean
          nullable: true
          title: Aktiviert Seitenrotation
        rotate_pages_threshold:
          type: number
          format: double
          minimum: 0.0
          nullable: true
          title: Legt die Schwelle für die Seitenrotation fest
        max_image_pixels:
          type: number
          format: double
          minimum: 0.0
          nullable: true
          title: Legt die maximale Bildgröße für die Dekomprimierung fest
        color_conversion_strategy:
          nullable: true
          title: Legt die Ghostscript-Farbkonvertierungsstrategie fest
          oneOf:
          - $ref: '#/components/schemas/ColorConversionStrategyEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        app_title:
          type: string
          nullable: true
          title: Anwendungstitel
          maxLength: 48
        app_logo:
          type: string
          format: binary
          nullable: true
          title: Anwendungslogo
          pattern: (?:jpg|png|gif|svg)$
        barcodes_enabled:
          type: boolean
          nullable: true
          title: Aktiviert Barcode-Scan
        barcode_enable_tiff_support:
          type: boolean
          nullable: true
          title: Aktiviert Barcode-TIFF-Unterstützung
        barcode_string:
          type: string
          nullable: true
          title: Legt die Barcode-Zeichenkette fest
          maxLength: 32
        barcode_retain_split_pages:
          type: boolean
          nullable: true
          title: Behält geteilte Seiten
        barcode_enable_asn:
          type: boolean
          nullable: true
          title: Aktiviert ASN-Barcode
        barcode_asn_prefix:
          type: string
          nullable: true
          title: Legt den ASN-Barcodepräfix fest
          maxLength: 32
        barcode_upscale:
          type: number
          format: double
          minimum: 1.0
          nullable: true
          title: Legt den Barcode-Hochskalierungsfaktor fest
        barcode_dpi:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Legt die Barcode-DPI fest
        barcode_max_pages:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Legt die maximale Anzahl an Seiten für Barcodes fest
        barcode_enable_tag:
          type: boolean
          nullable: true
          title: Aktiviert Tag-Barcode
      required:
      - barcode_tag_mapping
      - user_args
    AssignCorrespondentFromEnum:
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: |-
        * `1` - Keinen Korrespondenten zuweisen
        * `2` - E-Mail-Adresse verwenden
        * `3` - Absendername verwenden (oder E-Mail-Adresse, wenn nicht verfügbar)
        * `4` - Nachfolgend ausgewählten Korrespondent verwenden
    AssignTitleFromEnum:
      enum:
      - 1
      - 2
      - 3
      type: integer
      description: |-
        * `1` - Betreff als Titel verwenden
        * `2` - Dateiname des Anhangs als Titel verwenden
        * `3` - Titel nicht aus Regel zuweisen
    AttachmentTypeEnum:
      enum:
      - 1
      - 2
      type: integer
      description: |-
        * `1` - Nur Anhänge verarbeiten.
        * `2` - Alle Dateien verarbeiten, auch 'inline'-Anhänge.
    BasicUser:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        username:
          type: string
          title: Benutzername
          description: Erforderlich. 150 Zeichen oder weniger. Nur Buchstaben, Ziffern
            und @/./+/-/_.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        first_name:
          type: string
          title: Vorname
          maxLength: 150
        last_name:
          type: string
          title: Nachname
          maxLength: 150
      required:
      - id
      - username
    BasicUserRequest:
      type: object
      properties:
        username:
          type: string
          minLength: 1
          title: Benutzername
          description: Erforderlich. 150 Zeichen oder weniger. Nur Buchstaben, Ziffern
            und @/./+/-/_.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        first_name:
          type: string
          title: Vorname
          maxLength: 150
        last_name:
          type: string
          title: Nachname
          maxLength: 150
      required:
      - username
    BlankEnum:
      enum:
      - ''
    BulkDownload:
      type: object
      properties:
        content:
          allOf:
          - $ref: '#/components/schemas/ContentEnum'
          default: archive
        compression:
          allOf:
          - $ref: '#/components/schemas/CompressionEnum'
          default: none
        follow_formatting:
          type: boolean
          default: false
    BulkDownloadRequest:
      type: object
      properties:
        documents:
          type: array
          items:
            type: integer
          writeOnly: true
        content:
          allOf:
          - $ref: '#/components/schemas/ContentEnum'
          default: archive
        compression:
          allOf:
          - $ref: '#/components/schemas/CompressionEnum'
          default: none
        follow_formatting:
          type: boolean
          default: false
      required:
      - documents
    BulkEditDocumentsResult:
      type: object
      properties:
        result:
          type: string
      required:
      - result
    BulkEditObjectsRequest:
      type: object
      properties:
        objects:
          type: array
          items:
            type: integer
          writeOnly: true
        object_type:
          allOf:
          - $ref: '#/components/schemas/ObjectTypeEnum'
          writeOnly: true
        operation:
          allOf:
          - $ref: '#/components/schemas/OperationEnum'
          writeOnly: true
        owner:
          type: integer
          nullable: true
        permissions:
          type: object
          additionalProperties: {}
          writeOnly: true
          title: Set permissions
        merge:
          type: boolean
          writeOnly: true
          default: false
      required:
      - object_type
      - objects
      - operation
    BulkEditRequest:
      type: object
      properties:
        documents:
          type: array
          items:
            type: integer
          writeOnly: true
        method:
          allOf:
          - $ref: '#/components/schemas/MethodEnum'
          writeOnly: true
        parameters:
          type: object
          additionalProperties: {}
          writeOnly: true
          default: {}
      required:
      - documents
      - method
    BulkEditResult:
      type: object
      properties:
        result:
          type: string
      required:
      - result
    Classifier:
      type: object
      properties:
        status:
          type: string
        error:
          type: string
        last_trained:
          type: string
          format: date-time
      required:
      - error
      - last_trained
      - status
    ColorConversionStrategyEnum:
      enum:
      - LeaveColorUnchanged
      - RGB
      - UseDeviceIndependentColor
      - Gray
      - CMYK
      type: string
      description: |-
        * `LeaveColorUnchanged` - LeaveColorUnchanged
        * `RGB` - RGB
        * `UseDeviceIndependentColor` - UseDeviceIndependentColor
        * `Gray` - Grau
        * `CMYK` - CMYK
    CompressionEnum:
      enum:
      - none
      - deflated
      - bzip2
      - lzma
      type: string
      description: |-
        * `none` - none
        * `deflated` - deflated
        * `bzip2` - bzip2
        * `lzma` - lzma
    ConsumptionScopeEnum:
      enum:
      - 1
      - 2
      - 3
      type: integer
      description: |-
        * `1` - Nur Anhänge verarbeiten.
        * `2` - Vollständige E-Mail (mit eingebetteten Anhängen in der Datei) als .eml verarbeiten
        * `3` - Vollständige Mail (mit eingebetteten Anhängen in der Datei) als .eml verarbeiten + Anhänge als separate Dokumente verarbeiten
    ContentEnum:
      enum:
      - archive
      - originals
      - both
      type: string
      description: |-
        * `archive` - archive
        * `originals` - originals
        * `both` - both
    Correspondent:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        slug:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 128
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        document_count:
          type: integer
          readOnly: true
        last_correspondence:
          type: string
          format: date
          readOnly: true
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          readOnly: true
        user_can_change:
          type: boolean
          readOnly: true
      required:
      - document_count
      - id
      - last_correspondence
      - name
      - permissions
      - slug
      - user_can_change
    CorrespondentCounts:
      type: object
      properties:
        id:
          type: integer
        document_count:
          type: integer
      required:
      - document_count
      - id
    CorrespondentRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
      required:
      - name
    CustomField:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        data_type:
          $ref: '#/components/schemas/DataTypeEnum'
        extra_data:
          nullable: true
          title: Zusätzliche Daten
          description: Zusätzliche Daten für das benutzerdefinierte Feld, z. B. Auswahloptionen
        document_count:
          type: integer
          readOnly: true
      required:
      - data_type
      - document_count
      - id
      - name
    CustomFieldCounts:
      type: object
      properties:
        id:
          type: integer
        document_count:
          type: integer
      required:
      - document_count
      - id
    CustomFieldInstance:
      type: object
      properties:
        value:
          oneOf:
          - type: string
          - type: integer
          - type: number
            format: double
          - type: object
            additionalProperties: {}
          nullable: true
          description: |-
            Given the *incoming* primitive data, return the value for this field
            that should be validated and transformed to a native value.
        field:
          type: integer
      required:
      - field
      - value
    CustomFieldInstanceRequest:
      type: object
      properties:
        value:
          oneOf:
          - type: string
          - type: integer
          - type: number
            format: double
          - type: object
            additionalProperties: {}
          nullable: true
          description: |-
            Given the *incoming* primitive data, return the value for this field
            that should be validated and transformed to a native value.
        field:
          type: integer
      required:
      - field
      - value
    CustomFieldRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        data_type:
          $ref: '#/components/schemas/DataTypeEnum'
        extra_data:
          nullable: true
          title: Zusätzliche Daten
          description: Zusätzliche Daten für das benutzerdefinierte Feld, z. B. Auswahloptionen
      required:
      - data_type
      - name
    DataTypeEnum:
      enum:
      - string
      - url
      - date
      - boolean
      - integer
      - float
      - monetary
      - documentlink
      - select
      - longtext
      type: string
      description: |-
        * `string` - string
        * `url` - url
        * `date` - date
        * `boolean` - boolean
        * `integer` - integer
        * `float` - float
        * `monetary` - monetary
        * `documentlink` - documentlink
        * `select` - select
        * `longtext` - longtext
    Database:
      type: object
      properties:
        type:
          type: string
        url:
          type: string
        status:
          type: string
        error:
          type: string
        migration_status:
          $ref: '#/components/schemas/MigrationStatus'
      required:
      - error
      - migration_status
      - status
      - type
      - url
    DisplayModeEnum:
      enum:
      - table
      - smallCards
      - largeCards
      type: string
      description: |-
        * `table` - Tabelle
        * `smallCards` - Kleine Karten
        * `largeCards` - Große Karten
    Document:
      type: object
      description: Adds update nested feature
      properties:
        id:
          type: integer
          readOnly: true
        correspondent:
          type: integer
          nullable: true
        document_type:
          type: integer
          nullable: true
        storage_path:
          type: integer
          nullable: true
        title:
          type: string
          title: Titel
          maxLength: 128
        content:
          type: string
          title: Inhalt
          description: Der Inhalt des Dokuments in Textform. Dieses Feld wird primär
            für die Suche verwendet.
        tags:
          type: array
          items:
            type: integer
        created:
          type: string
          format: date
          title: Ausgestellt
        created_date:
          type: string
          format: date
          deprecated: true
        modified:
          type: string
          format: date-time
          readOnly: true
          title: Geändert
        added:
          type: string
          format: date-time
          readOnly: true
          title: Hinzugefügt
        deleted_at:
          type: string
          format: date-time
          nullable: true
        archive_serial_number:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
          title: Archiv-Seriennummer
          description: Die Position dieses Dokuments in Ihrem physischen Dokumentenarchiv.
        original_file_name:
          type: string
          nullable: true
          readOnly: true
        archived_file_name:
          type: string
          nullable: true
          readOnly: true
        owner:
          type: integer
          nullable: true
        permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          readOnly: true
        user_can_change:
          type: boolean
          readOnly: true
        is_shared_by_requester:
          type: boolean
          readOnly: true
        notes:
          type: array
          items:
            $ref: '#/components/schemas/Notes'
          readOnly: true
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldInstance'
        page_count:
          type: integer
          nullable: true
          readOnly: true
        mime_type:
          type: string
          readOnly: true
          title: MIME-Typ
      required:
      - added
      - archived_file_name
      - correspondent
      - document_type
      - id
      - is_shared_by_requester
      - mime_type
      - modified
      - notes
      - original_file_name
      - page_count
      - permissions
      - storage_path
      - tags
      - user_can_change
    DocumentListRequest:
      type: object
      properties:
        documents:
          type: array
          items:
            type: integer
          writeOnly: true
      required:
      - documents
    DocumentRequest:
      type: object
      description: Adds update nested feature
      properties:
        correspondent:
          type: integer
          nullable: true
        document_type:
          type: integer
          nullable: true
        storage_path:
          type: integer
          nullable: true
        title:
          type: string
          title: Titel
          maxLength: 128
        content:
          type: string
          title: Inhalt
          description: Der Inhalt des Dokuments in Textform. Dieses Feld wird primär
            für die Suche verwendet.
        tags:
          type: array
          items:
            type: integer
        created:
          type: string
          format: date
          title: Ausgestellt
        created_date:
          type: string
          format: date
          deprecated: true
        deleted_at:
          type: string
          format: date-time
          nullable: true
        archive_serial_number:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
          title: Archiv-Seriennummer
          description: Die Position dieses Dokuments in Ihrem physischen Dokumentenarchiv.
        owner:
          type: integer
          nullable: true
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldInstanceRequest'
        remove_inbox_tags:
          type: boolean
          writeOnly: true
          nullable: true
          default: false
      required:
      - correspondent
      - document_type
      - storage_path
      - tags
    DocumentType:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        slug:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 128
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        document_count:
          type: integer
          readOnly: true
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          readOnly: true
        user_can_change:
          type: boolean
          readOnly: true
      required:
      - document_count
      - id
      - name
      - permissions
      - slug
      - user_can_change
    DocumentTypeCounts:
      type: object
      properties:
        id:
          type: integer
        document_count:
          type: integer
      required:
      - document_count
      - id
    DocumentTypeRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
      required:
      - name
    EmailDocumentRequestRequest:
      type: object
      properties:
        addresses:
          type: string
          minLength: 1
          title: Email addresses
          description: Comma-separated email addresses
        subject:
          type: string
          minLength: 1
          title: Email subject
        message:
          type: string
          minLength: 1
          title: Email message
        use_archive_version:
          type: boolean
          default: true
          description: Use archive version of documents if available
      required:
      - addresses
      - message
      - subject
    EmailDocumentResponse:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    EmailDocumentsResponse:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    EmailRequest:
      type: object
      properties:
        documents:
          type: array
          items:
            type: integer
          writeOnly: true
        addresses:
          type: string
          minLength: 1
          title: Email addresses
          description: Comma-separated email addresses
        subject:
          type: string
          minLength: 1
          title: Email subject
        message:
          type: string
          minLength: 1
          title: Email message
        use_archive_version:
          type: boolean
          default: true
          description: Use archive version of documents if available
      required:
      - addresses
      - documents
      - message
      - subject
    FileVersionEnum:
      enum:
      - archive
      - original
      type: string
      description: |-
        * `archive` - Archiv
        * `original` - Original
    Group:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 150
        permissions:
          type: array
          items:
            type: string
      required:
      - id
      - name
      - permissions
    GroupRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 150
        permissions:
          type: array
          items:
            type: string
            minLength: 1
      required:
      - name
      - permissions
    ImapSecurityEnum:
      enum:
      - 1
      - 2
      - 3
      type: integer
      description: |-
        * `1` - Keine Verschlüsselung
        * `2` - SSL verwenden
        * `3` - STARTTLS verwenden
    Index:
      type: object
      properties:
        status:
          type: string
        error:
          type: string
        last_modified:
          type: string
          format: date-time
      required:
      - error
      - last_modified
      - status
    LogEntry:
      type: object
      properties:
        id:
          type: integer
        timestamp:
          type: string
          format: date-time
        action:
          type: string
        changes:
          type: object
          additionalProperties: {}
        actor:
          $ref: '#/components/schemas/Actor'
      required:
      - action
      - actor
      - changes
      - id
      - timestamp
    MailAccount:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 256
        imap_server:
          type: string
          maxLength: 256
        imap_port:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
          description: Dies ist in der Regel 143 für unverschlüsselte und STARTTLS-Verbindungen
            und 993 für SSL-Verbindungen.
        imap_security:
          allOf:
          - $ref: '#/components/schemas/ImapSecurityEnum'
          title: IMAP-Sicherheit
          minimum: 0
          maximum: 2147483647
        username:
          type: string
          title: Benutzername
          maxLength: 256
        password:
          type: string
        character_set:
          type: string
          title: Zeichensatz
          description: Der Zeichensatz, der bei der Kommunikation mit dem E-Mail-Server
            verwendet werden soll, wie z. B. „UTF-8“ oder „US-ASCII“.
          maxLength: 256
        is_token:
          type: boolean
          title: Ist Tokenauthentifizierung
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        user_can_change:
          type: boolean
          readOnly: true
        account_type:
          allOf:
          - $ref: '#/components/schemas/AccountTypeEnum'
          title: Kontotyp
          minimum: 0
          maximum: 2147483647
        expiration:
          type: string
          format: date-time
          nullable: true
          title: Ablauf
          description: 'Das Ablaufdatum des Aktualisierungstokens. '
      required:
      - id
      - imap_server
      - name
      - password
      - user_can_change
      - username
    MailAccountProcessResponse:
      type: object
      properties:
        result:
          type: string
          default: OK
    MailAccountRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 256
        imap_server:
          type: string
          minLength: 1
          maxLength: 256
        imap_port:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
          description: Dies ist in der Regel 143 für unverschlüsselte und STARTTLS-Verbindungen
            und 993 für SSL-Verbindungen.
        imap_security:
          allOf:
          - $ref: '#/components/schemas/ImapSecurityEnum'
          title: IMAP-Sicherheit
          minimum: 0
          maximum: 2147483647
        username:
          type: string
          minLength: 1
          title: Benutzername
          maxLength: 256
        password:
          type: string
          minLength: 1
        character_set:
          type: string
          minLength: 1
          title: Zeichensatz
          description: Der Zeichensatz, der bei der Kommunikation mit dem E-Mail-Server
            verwendet werden soll, wie z. B. „UTF-8“ oder „US-ASCII“.
          maxLength: 256
        is_token:
          type: boolean
          title: Ist Tokenauthentifizierung
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
        account_type:
          allOf:
          - $ref: '#/components/schemas/AccountTypeEnum'
          title: Kontotyp
          minimum: 0
          maximum: 2147483647
        expiration:
          type: string
          format: date-time
          nullable: true
          title: Ablauf
          description: 'Das Ablaufdatum des Aktualisierungstokens. '
      required:
      - imap_server
      - name
      - password
      - username
    MailAccountTestResponse:
      type: object
      properties:
        success:
          type: boolean
      required:
      - success
    MailRule:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 256
        account:
          type: integer
        enabled:
          type: boolean
          title: Aktiviert
        folder:
          type: string
          title: Ordner
          description: Unterordner müssen durch ein Trennzeichen, oft einen Punkt
            („.“) oder einen Schrägstrich („/“), getrennt werden. Dies variiert jedoch
            je nach Mailserver.
          maxLength: 256
        filter_from:
          type: string
          nullable: true
          title: Absender filtern
          maxLength: 256
        filter_to:
          type: string
          nullable: true
          title: Empfänger filtern
          maxLength: 256
        filter_subject:
          type: string
          nullable: true
          title: Betreff filtern
          maxLength: 256
        filter_body:
          type: string
          nullable: true
          title: Nachrichteninhalt filtern
          maxLength: 256
        filter_attachment_filename_include:
          type: string
          nullable: true
          title: 'Filter: Anhang-Dateiname (inklusiv)'
          description: Nur Dokumente, die vollständig mit diesem Dateinamen (falls
            angegeben) übereinstimmen, verarbeiten. Platzhalter wie *.pdf oder *rechnung*
            sind erlaubt. Groß- und Kleinschreibung wird nicht beachtet.
          maxLength: 256
        filter_attachment_filename_exclude:
          type: string
          nullable: true
          title: 'Filter: Anhang-Dateiname (exklusiv)'
          description: Dokumente, die vollständig mit diesem Dateinamen (falls angegeben)
            übereinstimmen, nicht verarbeiten. Platzhalter wie *.pdf oder *rechnung*
            sind erlaubt. Groß- und Kleinschreibung wird nicht beachtet.
          maxLength: 256
        maximum_age:
          type: integer
          maximum: 2147483647
          minimum: 0
          title: Maximales Alter
          description: Angegeben in Tagen.
        action:
          allOf:
          - $ref: '#/components/schemas/MailRuleActionEnum'
          title: Aktion
          minimum: 0
          maximum: 2147483647
        action_parameter:
          type: string
          nullable: true
          default: ''
        assign_title_from:
          allOf:
          - $ref: '#/components/schemas/AssignTitleFromEnum'
          title: Titel zuweisen von
          minimum: 0
          maximum: 2147483647
        assign_tags:
          type: array
          items:
            type: integer
            nullable: true
        assign_correspondent_from:
          allOf:
          - $ref: '#/components/schemas/AssignCorrespondentFromEnum'
          title: Korrespondent zuweisen von
          minimum: 0
          maximum: 2147483647
        assign_correspondent:
          type: integer
          nullable: true
        assign_document_type:
          type: integer
          nullable: true
        assign_owner_from_rule:
          type: boolean
          title: Dokumenten den Regeleigentümer zuweisen
        order:
          type: integer
        attachment_type:
          allOf:
          - $ref: '#/components/schemas/AttachmentTypeEnum'
          title: Dateianhangstyp
          description: |-
            „Inline“-Anhänge schließen eingebettete Bilder mit ein, daher sollte diese Einstellung mit einem Dateinamenfilter kombiniert werden.

            * `1` - Nur Anhänge verarbeiten.
            * `2` - Alle Dateien verarbeiten, auch 'inline'-Anhänge.
          minimum: 0
          maximum: 2147483647
        consumption_scope:
          allOf:
          - $ref: '#/components/schemas/ConsumptionScopeEnum'
          title: Verarbeitungsumfang
          minimum: 0
          maximum: 2147483647
        pdf_layout:
          allOf:
          - $ref: '#/components/schemas/PdfLayoutEnum'
          minimum: 0
          maximum: 2147483647
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        user_can_change:
          type: boolean
          readOnly: true
      required:
      - account
      - id
      - name
      - user_can_change
    MailRuleActionEnum:
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
      description: |-
        * `1` - Löschen
        * `2` - In angegebenen Ordner verschieben
        * `3` - Als gelesen markieren, gelesene E-Mails nicht verarbeiten
        * `4` - Als wichtig markieren, markierte E-Mails nicht verarbeiten
        * `5` - Markiere die E-Mail mit dem angegebenen Tag, verarbeite markierte E-Mails nicht
    MailRuleRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 256
        account:
          type: integer
        enabled:
          type: boolean
          title: Aktiviert
        folder:
          type: string
          minLength: 1
          title: Ordner
          description: Unterordner müssen durch ein Trennzeichen, oft einen Punkt
            („.“) oder einen Schrägstrich („/“), getrennt werden. Dies variiert jedoch
            je nach Mailserver.
          maxLength: 256
        filter_from:
          type: string
          nullable: true
          title: Absender filtern
          maxLength: 256
        filter_to:
          type: string
          nullable: true
          title: Empfänger filtern
          maxLength: 256
        filter_subject:
          type: string
          nullable: true
          title: Betreff filtern
          maxLength: 256
        filter_body:
          type: string
          nullable: true
          title: Nachrichteninhalt filtern
          maxLength: 256
        filter_attachment_filename_include:
          type: string
          nullable: true
          title: 'Filter: Anhang-Dateiname (inklusiv)'
          description: Nur Dokumente, die vollständig mit diesem Dateinamen (falls
            angegeben) übereinstimmen, verarbeiten. Platzhalter wie *.pdf oder *rechnung*
            sind erlaubt. Groß- und Kleinschreibung wird nicht beachtet.
          maxLength: 256
        filter_attachment_filename_exclude:
          type: string
          nullable: true
          title: 'Filter: Anhang-Dateiname (exklusiv)'
          description: Dokumente, die vollständig mit diesem Dateinamen (falls angegeben)
            übereinstimmen, nicht verarbeiten. Platzhalter wie *.pdf oder *rechnung*
            sind erlaubt. Groß- und Kleinschreibung wird nicht beachtet.
          maxLength: 256
        maximum_age:
          type: integer
          maximum: 2147483647
          minimum: 0
          title: Maximales Alter
          description: Angegeben in Tagen.
        action:
          allOf:
          - $ref: '#/components/schemas/MailRuleActionEnum'
          title: Aktion
          minimum: 0
          maximum: 2147483647
        action_parameter:
          type: string
          nullable: true
          minLength: 1
          default: ''
        assign_title_from:
          allOf:
          - $ref: '#/components/schemas/AssignTitleFromEnum'
          title: Titel zuweisen von
          minimum: 0
          maximum: 2147483647
        assign_tags:
          type: array
          items:
            type: integer
            nullable: true
        assign_correspondent_from:
          allOf:
          - $ref: '#/components/schemas/AssignCorrespondentFromEnum'
          title: Korrespondent zuweisen von
          minimum: 0
          maximum: 2147483647
        assign_correspondent:
          type: integer
          nullable: true
        assign_document_type:
          type: integer
          nullable: true
        assign_owner_from_rule:
          type: boolean
          title: Dokumenten den Regeleigentümer zuweisen
        order:
          type: integer
        attachment_type:
          allOf:
          - $ref: '#/components/schemas/AttachmentTypeEnum'
          title: Dateianhangstyp
          description: |-
            „Inline“-Anhänge schließen eingebettete Bilder mit ein, daher sollte diese Einstellung mit einem Dateinamenfilter kombiniert werden.

            * `1` - Nur Anhänge verarbeiten.
            * `2` - Alle Dateien verarbeiten, auch 'inline'-Anhänge.
          minimum: 0
          maximum: 2147483647
        consumption_scope:
          allOf:
          - $ref: '#/components/schemas/ConsumptionScopeEnum'
          title: Verarbeitungsumfang
          minimum: 0
          maximum: 2147483647
        pdf_layout:
          allOf:
          - $ref: '#/components/schemas/PdfLayoutEnum'
          minimum: 0
          maximum: 2147483647
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
      required:
      - account
      - name
    MatchingAlgorithm:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
      description: |-
        * `0` - Keine
        * `1` - Irgendein Wort
        * `2` - Alle Wörter
        * `3` - Exakte Übereinstimmung
        * `4` - Regulärer Ausdruck
        * `5` - Ungenaues Wort
        * `6` - Automatisch
    Metadata:
      type: object
      properties:
        original_checksum:
          type: string
        original_size:
          type: integer
        original_mime_type:
          type: string
        media_filename:
          type: string
        has_archive_version:
          type: boolean
        original_metadata:
          type: object
          additionalProperties: {}
        archive_checksum:
          type: string
        archive_media_filename:
          type: string
        original_filename:
          type: string
        archive_size:
          type: integer
        archive_metadata:
          type: object
          additionalProperties: {}
        lang:
          type: string
      required:
      - archive_checksum
      - archive_media_filename
      - archive_metadata
      - archive_size
      - has_archive_version
      - lang
      - media_filename
      - original_checksum
      - original_filename
      - original_metadata
      - original_mime_type
      - original_size
    MethodEnum:
      enum:
      - set_correspondent
      - set_document_type
      - set_storage_path
      - add_tag
      - remove_tag
      - modify_tags
      - modify_custom_fields
      - delete
      - reprocess
      - set_permissions
      - rotate
      - merge
      - split
      - delete_pages
      - edit_pdf
      type: string
      description: |-
        * `set_correspondent` - set_correspondent
        * `set_document_type` - set_document_type
        * `set_storage_path` - set_storage_path
        * `add_tag` - add_tag
        * `remove_tag` - remove_tag
        * `modify_tags` - modify_tags
        * `modify_custom_fields` - modify_custom_fields
        * `delete` - delete
        * `reprocess` - reprocess
        * `set_permissions` - set_permissions
        * `rotate` - rotate
        * `merge` - merge
        * `split` - split
        * `delete_pages` - delete_pages
        * `edit_pdf` - edit_pdf
    MigrationStatus:
      type: object
      properties:
        latest_migration:
          type: string
        unapplied_migrations:
          type: array
          items:
            type: string
      required:
      - latest_migration
      - unapplied_migrations
    ModeEnum:
      enum:
      - skip
      - redo
      - force
      - skip_noarchive
      type: string
      description: |-
        * `skip` - überspringen
        * `redo` - wiederholen
        * `force` - erzwingen
        * `skip_noarchive` - skip_noarchive
    NoteCreateRequestRequest:
      type: object
      properties:
        note:
          type: string
          minLength: 1
      required:
      - note
    Notes:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        note:
          type: string
          title: Inhalt
          description: Notiz für das Dokument
        created:
          type: string
          format: date-time
          title: Ausgestellt
        user:
          allOf:
          - $ref: '#/components/schemas/BasicUser'
          readOnly: true
      required:
      - id
      - user
    NotesRequest:
      type: object
      properties:
        note:
          type: string
          title: Inhalt
          description: Notiz für das Dokument
        created:
          type: string
          format: date-time
          title: Ausgestellt
    NullEnum:
      enum:
      - null
    ObjectTypeEnum:
      enum:
      - tags
      - correspondents
      - document_types
      - storage_paths
      type: string
      description: |-
        * `tags` - tags
        * `correspondents` - correspondents
        * `document_types` - document_types
        * `storage_paths` - storage_paths
    OperationEnum:
      enum:
      - set_permissions
      - delete
      type: string
      description: |-
        * `set_permissions` - set_permissions
        * `delete` - delete
    OutputTypeEnum:
      enum:
      - pdf
      - pdfa
      - pdfa-1
      - pdfa-2
      - pdfa-3
      type: string
      description: |-
        * `pdf` - pdf
        * `pdfa` - pdfa
        * `pdfa-1` - pdfa-1
        * `pdfa-2` - pdfa-2
        * `pdfa-3` - pdfa-3
    PaginatedCorrespondentList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Correspondent'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedCustomFieldList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/CustomField'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedDocumentList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Document'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedDocumentTypeList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/DocumentType'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedGroupList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Group'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedLogEntryList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/LogEntry'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedMailAccountList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/MailAccount'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedMailRuleList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/MailRule'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedNotesList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Notes'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedProcessedMailList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/ProcessedMail'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedSavedViewList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/SavedView'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedShareLinkList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/ShareLink'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedStoragePathList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/StoragePath'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedTagList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedUserList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/User'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedWorkflowActionList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowAction'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedWorkflowList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Workflow'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaginatedWorkflowTriggerList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowTrigger'
        all:
          type: array
          example: '[1, 2, 3]'
          items:
            type: integer
    PaperlessAuthToken:
      type: object
      properties:
        token:
          type: string
          readOnly: true
      required:
      - token
    PaperlessAuthTokenRequest:
      type: object
      properties:
        username:
          type: string
          writeOnly: true
          minLength: 1
          title: Benutzername
        password:
          type: string
          writeOnly: true
          minLength: 1
          title: Kennwort
        code:
          type: string
          writeOnly: true
          minLength: 1
          title: MFA Code
      required:
      - password
      - username
    PatchedApplicationConfigurationRequest:
      type: object
      properties:
        user_args:
          nullable: true
        barcode_tag_mapping:
          nullable: true
        output_type:
          nullable: true
          title: Legt den PDF-Typ der Ausgabedatei fest
          oneOf:
          - $ref: '#/components/schemas/OutputTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        pages:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: OCR von Seite 1 bis zu diesem Wert durchführen
        language:
          type: string
          nullable: true
          title: OCR für diese Sprachen durchführen
          maxLength: 32
        mode:
          nullable: true
          title: Legt den OCR-Modus fest
          oneOf:
          - $ref: '#/components/schemas/ModeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        skip_archive_file:
          nullable: true
          title: Steuert die Erzeugung einer Archivdatei
          oneOf:
          - $ref: '#/components/schemas/SkipArchiveFileEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        image_dpi:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Setzt den Bild-DPI Fallback-Wert
        unpaper_clean:
          nullable: true
          title: Steuert die unpaper-Bereinigung
          oneOf:
          - $ref: '#/components/schemas/UnpaperCleanEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        deskew:
          type: boolean
          nullable: true
          title: Aktiviert die Schräglagenkorrektur
        rotate_pages:
          type: boolean
          nullable: true
          title: Aktiviert Seitenrotation
        rotate_pages_threshold:
          type: number
          format: double
          minimum: 0.0
          nullable: true
          title: Legt die Schwelle für die Seitenrotation fest
        max_image_pixels:
          type: number
          format: double
          minimum: 0.0
          nullable: true
          title: Legt die maximale Bildgröße für die Dekomprimierung fest
        color_conversion_strategy:
          nullable: true
          title: Legt die Ghostscript-Farbkonvertierungsstrategie fest
          oneOf:
          - $ref: '#/components/schemas/ColorConversionStrategyEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        app_title:
          type: string
          nullable: true
          title: Anwendungstitel
          maxLength: 48
        app_logo:
          type: string
          format: binary
          nullable: true
          title: Anwendungslogo
          pattern: (?:jpg|png|gif|svg)$
        barcodes_enabled:
          type: boolean
          nullable: true
          title: Aktiviert Barcode-Scan
        barcode_enable_tiff_support:
          type: boolean
          nullable: true
          title: Aktiviert Barcode-TIFF-Unterstützung
        barcode_string:
          type: string
          nullable: true
          title: Legt die Barcode-Zeichenkette fest
          maxLength: 32
        barcode_retain_split_pages:
          type: boolean
          nullable: true
          title: Behält geteilte Seiten
        barcode_enable_asn:
          type: boolean
          nullable: true
          title: Aktiviert ASN-Barcode
        barcode_asn_prefix:
          type: string
          nullable: true
          title: Legt den ASN-Barcodepräfix fest
          maxLength: 32
        barcode_upscale:
          type: number
          format: double
          minimum: 1.0
          nullable: true
          title: Legt den Barcode-Hochskalierungsfaktor fest
        barcode_dpi:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Legt die Barcode-DPI fest
        barcode_max_pages:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Legt die maximale Anzahl an Seiten für Barcodes fest
        barcode_enable_tag:
          type: boolean
          nullable: true
          title: Aktiviert Tag-Barcode
    PatchedCorrespondentRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
    PatchedCustomFieldRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        data_type:
          $ref: '#/components/schemas/DataTypeEnum'
        extra_data:
          nullable: true
          title: Zusätzliche Daten
          description: Zusätzliche Daten für das benutzerdefinierte Feld, z. B. Auswahloptionen
    PatchedDocumentRequest:
      type: object
      description: Adds update nested feature
      properties:
        correspondent:
          type: integer
          nullable: true
        document_type:
          type: integer
          nullable: true
        storage_path:
          type: integer
          nullable: true
        title:
          type: string
          title: Titel
          maxLength: 128
        content:
          type: string
          title: Inhalt
          description: Der Inhalt des Dokuments in Textform. Dieses Feld wird primär
            für die Suche verwendet.
        tags:
          type: array
          items:
            type: integer
        created:
          type: string
          format: date
          title: Ausgestellt
        created_date:
          type: string
          format: date
          deprecated: true
        deleted_at:
          type: string
          format: date-time
          nullable: true
        archive_serial_number:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
          title: Archiv-Seriennummer
          description: Die Position dieses Dokuments in Ihrem physischen Dokumentenarchiv.
        owner:
          type: integer
          nullable: true
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldInstanceRequest'
        remove_inbox_tags:
          type: boolean
          writeOnly: true
          nullable: true
          default: false
    PatchedDocumentTypeRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
    PatchedGroupRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 150
        permissions:
          type: array
          items:
            type: string
            minLength: 1
    PatchedMailAccountRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 256
        imap_server:
          type: string
          minLength: 1
          maxLength: 256
        imap_port:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
          description: Dies ist in der Regel 143 für unverschlüsselte und STARTTLS-Verbindungen
            und 993 für SSL-Verbindungen.
        imap_security:
          allOf:
          - $ref: '#/components/schemas/ImapSecurityEnum'
          title: IMAP-Sicherheit
          minimum: 0
          maximum: 2147483647
        username:
          type: string
          minLength: 1
          title: Benutzername
          maxLength: 256
        password:
          type: string
          minLength: 1
        character_set:
          type: string
          minLength: 1
          title: Zeichensatz
          description: Der Zeichensatz, der bei der Kommunikation mit dem E-Mail-Server
            verwendet werden soll, wie z. B. „UTF-8“ oder „US-ASCII“.
          maxLength: 256
        is_token:
          type: boolean
          title: Ist Tokenauthentifizierung
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
        account_type:
          allOf:
          - $ref: '#/components/schemas/AccountTypeEnum'
          title: Kontotyp
          minimum: 0
          maximum: 2147483647
        expiration:
          type: string
          format: date-time
          nullable: true
          title: Ablauf
          description: 'Das Ablaufdatum des Aktualisierungstokens. '
    PatchedMailRuleRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 256
        account:
          type: integer
        enabled:
          type: boolean
          title: Aktiviert
        folder:
          type: string
          minLength: 1
          title: Ordner
          description: Unterordner müssen durch ein Trennzeichen, oft einen Punkt
            („.“) oder einen Schrägstrich („/“), getrennt werden. Dies variiert jedoch
            je nach Mailserver.
          maxLength: 256
        filter_from:
          type: string
          nullable: true
          title: Absender filtern
          maxLength: 256
        filter_to:
          type: string
          nullable: true
          title: Empfänger filtern
          maxLength: 256
        filter_subject:
          type: string
          nullable: true
          title: Betreff filtern
          maxLength: 256
        filter_body:
          type: string
          nullable: true
          title: Nachrichteninhalt filtern
          maxLength: 256
        filter_attachment_filename_include:
          type: string
          nullable: true
          title: 'Filter: Anhang-Dateiname (inklusiv)'
          description: Nur Dokumente, die vollständig mit diesem Dateinamen (falls
            angegeben) übereinstimmen, verarbeiten. Platzhalter wie *.pdf oder *rechnung*
            sind erlaubt. Groß- und Kleinschreibung wird nicht beachtet.
          maxLength: 256
        filter_attachment_filename_exclude:
          type: string
          nullable: true
          title: 'Filter: Anhang-Dateiname (exklusiv)'
          description: Dokumente, die vollständig mit diesem Dateinamen (falls angegeben)
            übereinstimmen, nicht verarbeiten. Platzhalter wie *.pdf oder *rechnung*
            sind erlaubt. Groß- und Kleinschreibung wird nicht beachtet.
          maxLength: 256
        maximum_age:
          type: integer
          maximum: 2147483647
          minimum: 0
          title: Maximales Alter
          description: Angegeben in Tagen.
        action:
          allOf:
          - $ref: '#/components/schemas/MailRuleActionEnum'
          title: Aktion
          minimum: 0
          maximum: 2147483647
        action_parameter:
          type: string
          nullable: true
          minLength: 1
          default: ''
        assign_title_from:
          allOf:
          - $ref: '#/components/schemas/AssignTitleFromEnum'
          title: Titel zuweisen von
          minimum: 0
          maximum: 2147483647
        assign_tags:
          type: array
          items:
            type: integer
            nullable: true
        assign_correspondent_from:
          allOf:
          - $ref: '#/components/schemas/AssignCorrespondentFromEnum'
          title: Korrespondent zuweisen von
          minimum: 0
          maximum: 2147483647
        assign_correspondent:
          type: integer
          nullable: true
        assign_document_type:
          type: integer
          nullable: true
        assign_owner_from_rule:
          type: boolean
          title: Dokumenten den Regeleigentümer zuweisen
        order:
          type: integer
        attachment_type:
          allOf:
          - $ref: '#/components/schemas/AttachmentTypeEnum'
          title: Dateianhangstyp
          description: |-
            „Inline“-Anhänge schließen eingebettete Bilder mit ein, daher sollte diese Einstellung mit einem Dateinamenfilter kombiniert werden.

            * `1` - Nur Anhänge verarbeiten.
            * `2` - Alle Dateien verarbeiten, auch 'inline'-Anhänge.
          minimum: 0
          maximum: 2147483647
        consumption_scope:
          allOf:
          - $ref: '#/components/schemas/ConsumptionScopeEnum'
          title: Verarbeitungsumfang
          minimum: 0
          maximum: 2147483647
        pdf_layout:
          allOf:
          - $ref: '#/components/schemas/PdfLayoutEnum'
          minimum: 0
          maximum: 2147483647
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
    PatchedProfileRequest:
      type: object
      properties:
        email:
          type: string
          format: email
        password:
          type: string
          minLength: 1
        first_name:
          type: string
          title: Vorname
          maxLength: 150
        last_name:
          type: string
          title: Nachname
          maxLength: 150
    PatchedSavedViewRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        show_on_dashboard:
          type: boolean
          title: Auf Startseite zeigen
        show_in_sidebar:
          type: boolean
          title: In Seitenleiste zeigen
        sort_field:
          type: string
          nullable: true
          title: Sortierfeld
          maxLength: 128
        sort_reverse:
          type: boolean
          title: Umgekehrte Sortierung
        filter_rules:
          type: array
          items:
            $ref: '#/components/schemas/SavedViewFilterRuleRequest'
        page_size:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Ansichts-Seitengröße
        display_mode:
          nullable: true
          title: Ansichts-Anzeigemodus
          oneOf:
          - $ref: '#/components/schemas/DisplayModeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        display_fields:
          nullable: true
          title: Angezeigte Dokumentenfelder
        owner:
          type: integer
          nullable: true
          title: Eigentümer
    PatchedShareLinkRequest:
      type: object
      properties:
        expiration:
          type: string
          format: date-time
          nullable: true
          title: Ablauf
        document:
          type: integer
          title: Dokument
        file_version:
          $ref: '#/components/schemas/FileVersionEnum'
    PatchedStoragePathRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        path:
          type: string
          minLength: 1
          title: Pfad
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
    PatchedTagRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        color:
          type: string
          minLength: 1
          title: Farbe
          maxLength: 7
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        is_inbox_tag:
          type: boolean
          title: Posteingangs-Tag
          description: Markiert das Tag als Posteingangs-Tag. Neue Dokumente werden
            immer mit diesem Tag versehen.
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
        parent:
          type: integer
          nullable: true
    PatchedUserRequest:
      type: object
      properties:
        username:
          type: string
          minLength: 1
          title: Benutzername
          description: Erforderlich. 150 Zeichen oder weniger. Nur Buchstaben, Ziffern
            und @/./+/-/_.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        email:
          type: string
          format: email
          title: E-Mail-Adresse
          maxLength: 254
        password:
          type: string
          minLength: 1
        first_name:
          type: string
          title: Vorname
          maxLength: 150
        last_name:
          type: string
          title: Nachname
          maxLength: 150
        date_joined:
          type: string
          format: date-time
          title: Mitglied seit
        is_staff:
          type: boolean
          title: Mitarbeiter-Status
          description: Legt fest, ob sich der Benutzer an der Administrationsseite
            anmelden kann.
        is_active:
          type: boolean
          title: Aktiv
          description: Legt fest, ob dieser Benutzer aktiv ist. Kann deaktiviert werden,
            anstatt Benutzer zu löschen.
        is_superuser:
          type: boolean
          title: Administrator-Status
          description: Legt fest, dass der Benutzer alle Berechtigungen hat, ohne
            diese einzeln zuweisen zu müssen.
        groups:
          type: array
          items:
            type: integer
            title: Gruppen
          title: Gruppen
          description: Die Gruppen, denen der Benutzer angehört. Ein Benutzer bekommt
            alle Berechtigungen dieser Gruppen.
        user_permissions:
          type: array
          items:
            type: string
            minLength: 1
    PatchedWorkflowActionRequest:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        type:
          allOf:
          - $ref: '#/components/schemas/WorkflowActionTypeEnum'
          title: Arbeitsablauf-Aktionstyp
          minimum: 0
          maximum: 2147483647
        assign_title:
          type: string
          nullable: true
          title: Titel zuweisen
          description: Dokumenttitel zuweisen (muss eine Jinja2-Vorlage sein, siehe
            Dokumentation).
        assign_tags:
          type: array
          items:
            type: integer
            nullable: true
        assign_correspondent:
          type: integer
          nullable: true
        assign_document_type:
          type: integer
          nullable: true
        assign_storage_path:
          type: integer
          nullable: true
        assign_owner:
          type: integer
          nullable: true
          title: Diesen Eigentümer zuordnen
        assign_view_users:
          type: array
          items:
            type: integer
            title: Diesen Benutzern Anzeigeberechtigungen erteilen
          title: Diesen Benutzern Anzeigeberechtigungen erteilen
        assign_view_groups:
          type: array
          items:
            type: integer
            title: Diesen Gruppen Anzeigeberechtigungen erteilen
          title: Diesen Gruppen Anzeigeberechtigungen erteilen
        assign_change_users:
          type: array
          items:
            type: integer
            title: Diesen Benutzern Bearbeitungsberechtigungen erteilen
          title: Diesen Benutzern Bearbeitungsberechtigungen erteilen
        assign_change_groups:
          type: array
          items:
            type: integer
            title: Diesen Gruppen Bearbeitungsberechtigungen erteilen
          title: Diesen Gruppen Bearbeitungsberechtigungen erteilen
        assign_custom_fields:
          type: array
          items:
            type: integer
            title: Diese benutzerdefinierten Felder zuweisen
          title: Diese benutzerdefinierten Felder zuweisen
        assign_custom_fields_values:
          nullable: true
          title: Benutzerdefinierte Feldwerte
          description: Optionale Werte, die den benutzerdefinierten Feldern zugewiesen
            werden.
        remove_all_tags:
          type: boolean
          title: Alle Tags entfernen
        remove_tags:
          type: array
          items:
            type: integer
            title: Diese(n) Tag(s) entfernen
          title: Diese(n) Tag(s) entfernen
        remove_all_correspondents:
          type: boolean
          title: Alle Korrespondenten entfernen
        remove_correspondents:
          type: array
          items:
            type: integer
            title: Diese(n) Korrespondenten entfernen
          title: Diese(n) Korrespondenten entfernen
        remove_all_document_types:
          type: boolean
          title: Alle Dokumenttypen entfernen
        remove_document_types:
          type: array
          items:
            type: integer
            title: Diese(n) Dokumenttyp(en) entfernen
          title: Diese(n) Dokumenttyp(en) entfernen
        remove_all_storage_paths:
          type: boolean
          title: Alle Speicherpfade entfernen
        remove_storage_paths:
          type: array
          items:
            type: integer
            title: Diese(n) Speicherpfad(e) entfernen
          title: Diese(n) Speicherpfad(e) entfernen
        remove_custom_fields:
          type: array
          items:
            type: integer
            title: Diese benutzerdefinierten Felder entfernen
          title: Diese benutzerdefinierten Felder entfernen
        remove_all_custom_fields:
          type: boolean
          title: Alle benutzerdefinierten Felder entfernen
        remove_all_owners:
          type: boolean
          title: Alle Eigentümer entfernen
        remove_owners:
          type: array
          items:
            type: integer
            title: Diese(n) Eigentümer entfernen
          title: Diese(n) Eigentümer entfernen
        remove_all_permissions:
          type: boolean
          title: Alle Berechtigungen entfernen
        remove_view_users:
          type: array
          items:
            type: integer
            title: Anzeigeberechtigungen für diese Benutzer entfernen
          title: Anzeigeberechtigungen für diese Benutzer entfernen
        remove_view_groups:
          type: array
          items:
            type: integer
            title: Anzeigeberechtigungen für diese Gruppen entfernen
          title: Anzeigeberechtigungen für diese Gruppen entfernen
        remove_change_users:
          type: array
          items:
            type: integer
            title: Bearbeitungsberechtigungen für diese Benutzer entfernen
          title: Bearbeitungsberechtigungen für diese Benutzer entfernen
        remove_change_groups:
          type: array
          items:
            type: integer
            title: Bearbeitungsberechtigungen für diese Gruppen entfernen
          title: Bearbeitungsberechtigungen für diese Gruppen entfernen
        email:
          allOf:
          - $ref: '#/components/schemas/WorkflowActionEmailRequest'
          nullable: true
        webhook:
          allOf:
          - $ref: '#/components/schemas/WorkflowActionWebhookRequest'
          nullable: true
    PatchedWorkflowRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 256
        order:
          type: integer
        enabled:
          type: boolean
          title: Aktiviert
        triggers:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowTriggerRequest'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowActionRequest'
    PatchedWorkflowTriggerRequest:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourcesEnum'
          default:
          - 1
          - 2
          - 3
        type:
          allOf:
          - $ref: '#/components/schemas/WorkflowTriggerTypeEnum'
          title: Trigger Type
        filter_path:
          type: string
          nullable: true
          title: Pfad filtern
          description: Nur Dokumente, die mit diesem Pfad (falls angegeben) übereinstimmen,
            verarbeiten. Platzhalter wie * sind erlaubt. Groß- und Kleinschreibung
            wird nicht beachtet.
          maxLength: 256
        filter_filename:
          type: string
          nullable: true
          title: Dateinamen filtern
          description: Nur Dokumente, die vollständig mit diesem Dateinamen (falls
            angegeben) übereinstimmen, verarbeiten. Platzhalter wie *.pdf oder *rechnung*
            sind erlaubt. Groß- und Kleinschreibung wird nicht beachtet.
          maxLength: 256
        filter_mailrule:
          type: integer
          nullable: true
          title: Dokumente aus dieser E-Mail-Regel filtern
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        filter_has_tags:
          type: array
          items:
            type: integer
            title: Hat diese(n) Tag(s)
          title: Hat diese(n) Tag(s)
        filter_has_all_tags:
          type: array
          items:
            type: integer
            title: Hat alle diese Tags
          title: Hat alle diese Tags
        filter_has_not_tags:
          type: array
          items:
            type: integer
            title: Hat diese Tags nicht
          title: Hat diese Tags nicht
        filter_custom_field_query:
          type: string
          nullable: true
          title: Filtern Benutzerdefinierte Feldabfrage
          description: JSON-kodierte Abfrage eines benutzerdefinierten Felds.
        filter_has_not_correspondents:
          type: array
          items:
            type: integer
            title: Hat diese Korrespondenten nicht
          title: Hat diese Korrespondenten nicht
        filter_has_not_document_types:
          type: array
          items:
            type: integer
            title: Hat diese Dokumenttypen nicht
          title: Hat diese Dokumenttypen nicht
        filter_has_not_storage_paths:
          type: array
          items:
            type: integer
            title: Hat diese Speicherpfade nicht
          title: Hat diese Speicherpfade nicht
        filter_has_correspondent:
          type: integer
          nullable: true
          title: Hat diesen Korrespondenten
        filter_has_document_type:
          type: integer
          nullable: true
          title: Hat diesen Dokumenttyp
        filter_has_storage_path:
          type: integer
          nullable: true
          title: Hat diesen Speicherpfad
        schedule_offset_days:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          title: Zeitplanversatz (Tage)
          description: Die Anzahl der Tage, um die der Zeitplanauslöser verschoben
            werden soll.
        schedule_is_recurring:
          type: boolean
          title: Zeitplan wiederholt sich
          description: Ob der Zeitplan wiederholt werden soll.
        schedule_recurring_interval_days:
          type: integer
          maximum: 2147483647
          minimum: 1
          title: Zeitplan-Wiederholungsverzögerung in Tagen
          description: Die Anzahl der Tage zwischen wiederkehrenden Zeitplanauslösern.
        schedule_date_field:
          allOf:
          - $ref: '#/components/schemas/ScheduleDateFieldEnum'
          title: Zeitplan-Datumsfeld
          description: |-
            Das zu prüfende Feld für einen Zeitplanauslöser.

            * `added` - Hinzugefügt
            * `created` - Ausgestellt
            * `modified` - Geändert
            * `custom_field` - Benutzerdefiniertes Feld
        schedule_date_custom_field:
          type: integer
          nullable: true
          title: Benutzerdefiniertes Zeitplan-Datumsfeld
    PdfLayoutEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: |-
        * `0` - Systemstandard
        * `1` - Text, dann HTML
        * `2` - HTML, dann Text
        * `3` - Nur HTML
        * `4` - Nur Text
    PostDocumentRequest:
      type: object
      properties:
        created:
          type: string
          format: date-time
          writeOnly: true
          nullable: true
        document:
          type: string
          format: binary
          writeOnly: true
        title:
          type: string
          writeOnly: true
          minLength: 1
        correspondent:
          type: integer
          writeOnly: true
          nullable: true
        document_type:
          type: integer
          writeOnly: true
          nullable: true
        storage_path:
          type: integer
          writeOnly: true
          nullable: true
        tags:
          type: array
          items:
            type: integer
            writeOnly: true
            title: Tags
          writeOnly: true
        archive_serial_number:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          writeOnly: true
          title: ASN
        custom_fields:
          writeOnly: true
        from_webui:
          type: boolean
          writeOnly: true
          title: Documents are from Paperless-ngx WebUI
      required:
      - document
    ProcessedMail:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        rule:
          type: integer
          readOnly: true
        folder:
          type: string
          readOnly: true
          title: Ordner
        uid:
          type: string
          readOnly: true
        subject:
          type: string
          readOnly: true
          title: Betreff
        received:
          type: string
          format: date-time
          readOnly: true
          title: Empfangen
        processed:
          type: string
          format: date-time
          readOnly: true
          title: Verarbeitet
        status:
          type: string
          readOnly: true
        error:
          type: string
          readOnly: true
          nullable: true
          title: Fehler
      required:
      - error
      - folder
      - id
      - processed
      - received
      - rule
      - status
      - subject
      - uid
    ProcessedMailRequest:
      type: object
      properties:
        owner:
          type: integer
          nullable: true
          title: Eigentümer
    Profile:
      type: object
      properties:
        email:
          type: string
          format: email
        password:
          type: string
        first_name:
          type: string
          title: Vorname
          maxLength: 150
        last_name:
          type: string
          title: Nachname
          maxLength: 150
        auth_token:
          type: string
          title: Schlüssel
          readOnly: true
        social_accounts:
          type: array
          items:
            $ref: '#/components/schemas/SocialAccount'
          readOnly: true
        has_usable_password:
          type: boolean
          readOnly: true
        is_mfa_enabled:
          type: boolean
          readOnly: true
      required:
      - auth_token
      - has_usable_password
      - is_mfa_enabled
      - social_accounts
    RuleTypeEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 36
      - 37
      - 38
      - 39
      - 40
      - 41
      - 42
      - 43
      - 44
      - 45
      - 46
      - 47
      type: integer
      description: |-
        * `0` - Titel enthält
        * `1` - Inhalt enthält
        * `2` - ASN ist
        * `3` - Korrespondent ist
        * `4` - Dokumenttyp ist
        * `5` - Ist im Posteingang
        * `6` - Hat Tag
        * `7` - Hat irgendein Tag
        * `8` - Ausgestellt vor
        * `9` - Ausgestellt nach
        * `10` - Ausgestellt im Jahr
        * `11` - Ausgestellt im Monat
        * `12` - Ausstellungstag ist
        * `13` - Hinzugefügt vor
        * `14` - Hinzugefügt nach
        * `15` - Geändert vor
        * `16` - Geändert nach
        * `17` - Hat nicht folgendes Tag
        * `18` - Dokument hat keine ASN
        * `19` - Titel oder Inhalt enthält
        * `20` - Volltextsuche
        * `21` - Ähnliche Dokumente
        * `22` - hat Tags in
        * `23` - ASN größer als
        * `24` - ASN kleiner als
        * `25` - Speicherpfad ist
        * `26` - hat Korrespondenten in
        * `27` - hat keinen Korrespondenten in
        * `28` - hat Dokumenttyp in
        * `29` - hat keinen Dokumenttyp in
        * `30` - hat Speicherpfad in
        * `31` - hat keinen Speicherpfad in
        * `32` - Eigentümer ist
        * `33` - hat Eigentümer in
        * `34` - hat keinen Eigentümer
        * `35` - hat keinen Eigentümer in
        * `36` - Hat benutzerdefinierten Feld-Wert
        * `37` - Ist von mir freigegeben
        * `38` - hat benutzerdefinierte Felder
        * `39` - hat die benutzerdefinierten Felder
        * `40` - hat nicht die benutzerdefinierten Felder
        * `41` - hat nicht das benutzerdefinierte Feld
        * `42` - benutzerdefinierte Feldabfrage
        * `43` - erstellt zu
        * `44` - erstellt von
        * `45` - hinzugefügt zu
        * `46` - hinzugefügt von
        * `47` - MIME-Typ ist
    SanityCheck:
      type: object
      properties:
        status:
          type: string
        error:
          type: string
        last_run:
          type: string
          format: date-time
      required:
      - error
      - last_run
      - status
    SavedView:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        show_on_dashboard:
          type: boolean
          title: Auf Startseite zeigen
        show_in_sidebar:
          type: boolean
          title: In Seitenleiste zeigen
        sort_field:
          type: string
          nullable: true
          title: Sortierfeld
          maxLength: 128
        sort_reverse:
          type: boolean
          title: Umgekehrte Sortierung
        filter_rules:
          type: array
          items:
            $ref: '#/components/schemas/SavedViewFilterRule'
        page_size:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Ansichts-Seitengröße
        display_mode:
          nullable: true
          title: Ansichts-Anzeigemodus
          oneOf:
          - $ref: '#/components/schemas/DisplayModeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        display_fields:
          nullable: true
          title: Angezeigte Dokumentenfelder
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        user_can_change:
          type: boolean
          readOnly: true
      required:
      - filter_rules
      - id
      - name
      - show_in_sidebar
      - show_on_dashboard
      - user_can_change
    SavedViewFilterRule:
      type: object
      properties:
        rule_type:
          allOf:
          - $ref: '#/components/schemas/RuleTypeEnum'
          title: Regeltyp
          minimum: 0
          maximum: 2147483647
        value:
          type: string
          nullable: true
          title: Wert
          maxLength: 255
      required:
      - rule_type
    SavedViewFilterRuleRequest:
      type: object
      properties:
        rule_type:
          allOf:
          - $ref: '#/components/schemas/RuleTypeEnum'
          title: Regeltyp
          minimum: 0
          maximum: 2147483647
        value:
          type: string
          nullable: true
          title: Wert
          maxLength: 255
      required:
      - rule_type
    SavedViewRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        show_on_dashboard:
          type: boolean
          title: Auf Startseite zeigen
        show_in_sidebar:
          type: boolean
          title: In Seitenleiste zeigen
        sort_field:
          type: string
          nullable: true
          title: Sortierfeld
          maxLength: 128
        sort_reverse:
          type: boolean
          title: Umgekehrte Sortierung
        filter_rules:
          type: array
          items:
            $ref: '#/components/schemas/SavedViewFilterRuleRequest'
        page_size:
          type: integer
          maximum: 2147483647
          minimum: 1
          nullable: true
          title: Ansichts-Seitengröße
        display_mode:
          nullable: true
          title: Ansichts-Anzeigemodus
          oneOf:
          - $ref: '#/components/schemas/DisplayModeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        display_fields:
          nullable: true
          title: Angezeigte Dokumentenfelder
        owner:
          type: integer
          nullable: true
          title: Eigentümer
      required:
      - filter_rules
      - name
      - show_in_sidebar
      - show_on_dashboard
    ScheduleDateFieldEnum:
      enum:
      - added
      - created
      - modified
      - custom_field
      type: string
      description: |-
        * `added` - Hinzugefügt
        * `created` - Ausgestellt
        * `modified` - Geändert
        * `custom_field` - Benutzerdefiniertes Feld
    SearchResult:
      type: object
      properties:
        total:
          type: integer
        documents:
          type: array
          items:
            $ref: '#/components/schemas/Document'
        saved_views:
          type: array
          items:
            $ref: '#/components/schemas/SavedView'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        correspondents:
          type: array
          items:
            $ref: '#/components/schemas/Correspondent'
        document_types:
          type: array
          items:
            $ref: '#/components/schemas/DocumentType'
        storage_paths:
          type: array
          items:
            $ref: '#/components/schemas/StoragePath'
        users:
          type: array
          items:
            $ref: '#/components/schemas/User'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/Group'
        mail_rules:
          type: array
          items:
            $ref: '#/components/schemas/MailRule'
        mail_accounts:
          type: array
          items:
            $ref: '#/components/schemas/MailAccount'
        workflows:
          type: array
          items:
            $ref: '#/components/schemas/Workflow'
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/CustomField'
      required:
      - correspondents
      - custom_fields
      - document_types
      - documents
      - groups
      - mail_accounts
      - mail_rules
      - saved_views
      - storage_paths
      - tags
      - total
      - users
      - workflows
    SelectionData:
      type: object
      properties:
        selected_correspondents:
          type: array
          items:
            $ref: '#/components/schemas/CorrespondentCounts'
        selected_tags:
          type: array
          items:
            $ref: '#/components/schemas/TagCounts'
        selected_document_types:
          type: array
          items:
            $ref: '#/components/schemas/DocumentTypeCounts'
        selected_storage_paths:
          type: array
          items:
            $ref: '#/components/schemas/StoragePathCounts'
        selected_custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldCounts'
      required:
      - selected_correspondents
      - selected_custom_fields
      - selected_document_types
      - selected_storage_paths
      - selected_tags
    ShareLink:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created:
          type: string
          format: date-time
          readOnly: true
          title: Ausgestellt
        expiration:
          type: string
          format: date-time
          nullable: true
          title: Ablauf
        slug:
          type: string
          readOnly: true
          pattern: ^[-a-zA-Z0-9_]+$
        document:
          type: integer
          title: Dokument
        file_version:
          $ref: '#/components/schemas/FileVersionEnum'
      required:
      - created
      - id
      - slug
    ShareLinkRequest:
      type: object
      properties:
        expiration:
          type: string
          format: date-time
          nullable: true
          title: Ablauf
        document:
          type: integer
          title: Dokument
        file_version:
          $ref: '#/components/schemas/FileVersionEnum'
    SkipArchiveFileEnum:
      enum:
      - never
      - with_text
      - always
      type: string
      description: |-
        * `never` - nie
        * `with_text` - with_text
        * `always` - immer
    SocialAccount:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        provider:
          type: string
          title: Anbieter
          maxLength: 200
        name:
          type: string
          readOnly: true
      required:
      - id
      - name
      - provider
    SocialAccountRequest:
      type: object
      properties:
        provider:
          type: string
          minLength: 1
          title: Anbieter
          maxLength: 200
      required:
      - provider
    SourcesEnum:
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: |-
        * `1` - Importordner
        * `2` - API-Upload
        * `3` - E-Mail-Abruf
        * `4` - Weboberfläche
    StatusEnum:
      enum:
      - FAILURE
      - PENDING
      - RECEIVED
      - RETRY
      - REVOKED
      - STARTED
      - SUCCESS
      type: string
      description: |-
        * `FAILURE` - FAILURE
        * `PENDING` - PENDING
        * `RECEIVED` - RECEIVED
        * `RETRY` - RETRY
        * `REVOKED` - REVOKED
        * `STARTED` - STARTED
        * `SUCCESS` - SUCCESS
    Storage:
      type: object
      properties:
        total:
          type: integer
        available:
          type: integer
      required:
      - available
      - total
    StoragePath:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        slug:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 128
        path:
          type: string
          title: Pfad
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        document_count:
          type: integer
          readOnly: true
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        user_can_change:
          type: boolean
          readOnly: true
      required:
      - document_count
      - id
      - name
      - path
      - slug
      - user_can_change
    StoragePathCounts:
      type: object
      properties:
        id:
          type: integer
        document_count:
          type: integer
      required:
      - document_count
      - id
    StoragePathRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        path:
          type: string
          minLength: 1
          title: Pfad
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
      required:
      - name
      - path
    Suggestions:
      type: object
      properties:
        correspondents:
          type: array
          items:
            type: integer
        tags:
          type: array
          items:
            type: integer
        document_types:
          type: array
          items:
            type: integer
        storage_paths:
          type: array
          items:
            type: integer
        dates:
          type: array
          items:
            type: string
      required:
      - correspondents
      - dates
      - document_types
      - storage_paths
      - tags
    SystemStatus:
      type: object
      properties:
        pngx_version:
          type: string
        server_os:
          type: string
        install_type:
          type: string
        storage:
          $ref: '#/components/schemas/Storage'
        database:
          $ref: '#/components/schemas/Database'
        tasks:
          $ref: '#/components/schemas/Tasks'
        index:
          $ref: '#/components/schemas/Index'
        classifier:
          $ref: '#/components/schemas/Classifier'
        sanity_check:
          $ref: '#/components/schemas/SanityCheck'
      required:
      - classifier
      - database
      - index
      - install_type
      - pngx_version
      - sanity_check
      - server_os
      - storage
      - tasks
    Tag:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        slug:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 128
        color:
          type: string
          title: Farbe
          maxLength: 7
        text_color:
          type: string
          readOnly: true
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        is_inbox_tag:
          type: boolean
          title: Posteingangs-Tag
          description: Markiert das Tag als Posteingangs-Tag. Neue Dokumente werden
            immer mit diesem Tag versehen.
        document_count:
          type: integer
          readOnly: true
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        user_can_change:
          type: boolean
          readOnly: true
        parent:
          type: integer
          nullable: true
        children:
          type: array
          items:
            type: integer
          readOnly: true
      required:
      - children
      - document_count
      - id
      - name
      - slug
      - text_color
      - user_can_change
    TagCounts:
      type: object
      properties:
        id:
          type: integer
        document_count:
          type: integer
      required:
      - document_count
      - id
    TagRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
        color:
          type: string
          minLength: 1
          title: Farbe
          maxLength: 7
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/MatchingAlgorithm'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        is_inbox_tag:
          type: boolean
          title: Posteingangs-Tag
          description: Markiert das Tag als Posteingangs-Tag. Neue Dokumente werden
            immer mit diesem Tag versehen.
        owner:
          type: integer
          nullable: true
          title: Eigentümer
        set_permissions:
          type: object
          properties:
            view:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
            change:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: integer
                groups:
                  type: array
                  items:
                    type: integer
          writeOnly: true
        parent:
          type: integer
          nullable: true
      required:
      - name
    TaskNameEnum:
      enum:
      - consume_file
      - train_classifier
      - check_sanity
      - index_optimize
      type: string
      description: |-
        * `consume_file` - Datei verarbeiten
        * `train_classifier` - Klassifikator trainieren
        * `check_sanity` - Plausibilität prüfen
        * `index_optimize` - Indexoptimierung
    Tasks:
      type: object
      properties:
        redis_url:
          type: string
        redis_status:
          type: string
        redis_error:
          type: string
        celery_status:
          type: string
      required:
      - celery_status
      - redis_error
      - redis_status
      - redis_url
    TasksView:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        task_id:
          type: string
          title: Aufgaben-ID
          description: Celery-ID für die ausgeführte Aufgabe
          maxLength: 255
        task_name:
          nullable: true
          title: Aufgabenname
          description: |-
            Name der ausgeführten Aufgabe

            * `consume_file` - Datei verarbeiten
            * `train_classifier` - Klassifikator trainieren
            * `check_sanity` - Plausibilität prüfen
            * `index_optimize` - Indexoptimierung
          oneOf:
          - $ref: '#/components/schemas/TaskNameEnum'
          - $ref: '#/components/schemas/NullEnum'
        task_file_name:
          type: string
          nullable: true
          title: Aufgaben-Dateiname
          description: Name der Datei, für die die Aufgabe ausgeführt wurde
          maxLength: 255
        date_created:
          type: string
          format: date-time
          nullable: true
          title: Erstellungsdatum/-zeit
          description: Zeitpunkt, an dem das Ergebnis der Aufgabe erstellt wurde (in
            UTC)
        date_done:
          type: string
          format: date-time
          nullable: true
          title: Abschlussdatum/-zeit
          description: Zeitpunkt, an dem die Aufgabe abgeschlossen wurde (in UTC)
        type:
          allOf:
          - $ref: '#/components/schemas/TasksViewTypeEnum'
          title: Aufgabentyp
          description: |-
            Art der ausgeführten Aufgabe

            * `auto_task` - Automatische Aufgabe
            * `scheduled_task` - Geplante Aufgabe
            * `manual_task` - Manuelle Aufgabe
        status:
          allOf:
          - $ref: '#/components/schemas/StatusEnum'
          title: Aufgabenstatus
          description: |-
            Aktueller Status der laufenden Aufgabe

            * `FAILURE` - FAILURE
            * `PENDING` - PENDING
            * `RECEIVED` - RECEIVED
            * `RETRY` - RETRY
            * `REVOKED` - REVOKED
            * `STARTED` - STARTED
            * `SUCCESS` - SUCCESS
        result:
          type: string
          nullable: true
          title: Ergebnisdaten
          description: Die von der Aufgabe zurückgegebenen Daten
        acknowledged:
          type: boolean
          title: Bestätigt
          description: Wenn die Aufgabe über die Benutzeroberfläche oder die API bestätigt
            wird
        related_document:
          type: string
          nullable: true
          readOnly: true
        owner:
          type: integer
          nullable: true
          title: Eigentümer
      required:
      - id
      - related_document
      - task_id
    TasksViewRequest:
      type: object
      properties:
        task_id:
          type: string
          minLength: 1
          title: Aufgaben-ID
          description: Celery-ID für die ausgeführte Aufgabe
          maxLength: 255
        task_name:
          nullable: true
          title: Aufgabenname
          description: |-
            Name der ausgeführten Aufgabe

            * `consume_file` - Datei verarbeiten
            * `train_classifier` - Klassifikator trainieren
            * `check_sanity` - Plausibilität prüfen
            * `index_optimize` - Indexoptimierung
          oneOf:
          - $ref: '#/components/schemas/TaskNameEnum'
          - $ref: '#/components/schemas/NullEnum'
        task_file_name:
          type: string
          nullable: true
          minLength: 1
          title: Aufgaben-Dateiname
          description: Name der Datei, für die die Aufgabe ausgeführt wurde
          maxLength: 255
        date_created:
          type: string
          format: date-time
          nullable: true
          title: Erstellungsdatum/-zeit
          description: Zeitpunkt, an dem das Ergebnis der Aufgabe erstellt wurde (in
            UTC)
        date_done:
          type: string
          format: date-time
          nullable: true
          title: Abschlussdatum/-zeit
          description: Zeitpunkt, an dem die Aufgabe abgeschlossen wurde (in UTC)
        type:
          allOf:
          - $ref: '#/components/schemas/TasksViewTypeEnum'
          title: Aufgabentyp
          description: |-
            Art der ausgeführten Aufgabe

            * `auto_task` - Automatische Aufgabe
            * `scheduled_task` - Geplante Aufgabe
            * `manual_task` - Manuelle Aufgabe
        status:
          allOf:
          - $ref: '#/components/schemas/StatusEnum'
          title: Aufgabenstatus
          description: |-
            Aktueller Status der laufenden Aufgabe

            * `FAILURE` - FAILURE
            * `PENDING` - PENDING
            * `RECEIVED` - RECEIVED
            * `RETRY` - RETRY
            * `REVOKED` - REVOKED
            * `STARTED` - STARTED
            * `SUCCESS` - SUCCESS
        result:
          type: string
          nullable: true
          minLength: 1
          title: Ergebnisdaten
          description: Die von der Aufgabe zurückgegebenen Daten
        acknowledged:
          type: boolean
          title: Bestätigt
          description: Wenn die Aufgabe über die Benutzeroberfläche oder die API bestätigt
            wird
        owner:
          type: integer
          nullable: true
          title: Eigentümer
      required:
      - task_id
    TasksViewTypeEnum:
      enum:
      - auto_task
      - scheduled_task
      - manual_task
      type: string
      description: |-
        * `auto_task` - Automatische Aufgabe
        * `scheduled_task` - Geplante Aufgabe
        * `manual_task` - Manuelle Aufgabe
    TrashActionEnum:
      enum:
      - restore
      - empty
      type: string
      description: |-
        * `restore` - restore
        * `empty` - empty
    TrashRequest:
      type: object
      properties:
        documents:
          type: array
          items:
            type: integer
          writeOnly: true
        action:
          allOf:
          - $ref: '#/components/schemas/TrashActionEnum'
          writeOnly: true
      required:
      - action
    UiSettingsView:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        settings:
          type: object
          additionalProperties: {}
          nullable: true
      required:
      - id
    UiSettingsViewRequest:
      type: object
      properties:
        settings:
          type: object
          additionalProperties: {}
          nullable: true
    UnpaperCleanEnum:
      enum:
      - clean
      - clean-final
      - none
      type: string
      description: |-
        * `clean` - bereinigen
        * `clean-final` - clean-final
        * `none` - keine
    User:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        username:
          type: string
          title: Benutzername
          description: Erforderlich. 150 Zeichen oder weniger. Nur Buchstaben, Ziffern
            und @/./+/-/_.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        email:
          type: string
          format: email
          title: E-Mail-Adresse
          maxLength: 254
        password:
          type: string
        first_name:
          type: string
          title: Vorname
          maxLength: 150
        last_name:
          type: string
          title: Nachname
          maxLength: 150
        date_joined:
          type: string
          format: date-time
          title: Mitglied seit
        is_staff:
          type: boolean
          title: Mitarbeiter-Status
          description: Legt fest, ob sich der Benutzer an der Administrationsseite
            anmelden kann.
        is_active:
          type: boolean
          title: Aktiv
          description: Legt fest, ob dieser Benutzer aktiv ist. Kann deaktiviert werden,
            anstatt Benutzer zu löschen.
        is_superuser:
          type: boolean
          title: Administrator-Status
          description: Legt fest, dass der Benutzer alle Berechtigungen hat, ohne
            diese einzeln zuweisen zu müssen.
        groups:
          type: array
          items:
            type: integer
            title: Gruppen
          title: Gruppen
          description: Die Gruppen, denen der Benutzer angehört. Ein Benutzer bekommt
            alle Berechtigungen dieser Gruppen.
        user_permissions:
          type: array
          items:
            type: string
        inherited_permissions:
          type: array
          items:
            type: string
          readOnly: true
        is_mfa_enabled:
          type: boolean
          readOnly: true
      required:
      - id
      - inherited_permissions
      - is_mfa_enabled
      - username
    UserRequest:
      type: object
      properties:
        username:
          type: string
          minLength: 1
          title: Benutzername
          description: Erforderlich. 150 Zeichen oder weniger. Nur Buchstaben, Ziffern
            und @/./+/-/_.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        email:
          type: string
          format: email
          title: E-Mail-Adresse
          maxLength: 254
        password:
          type: string
          minLength: 1
        first_name:
          type: string
          title: Vorname
          maxLength: 150
        last_name:
          type: string
          title: Nachname
          maxLength: 150
        date_joined:
          type: string
          format: date-time
          title: Mitglied seit
        is_staff:
          type: boolean
          title: Mitarbeiter-Status
          description: Legt fest, ob sich der Benutzer an der Administrationsseite
            anmelden kann.
        is_active:
          type: boolean
          title: Aktiv
          description: Legt fest, ob dieser Benutzer aktiv ist. Kann deaktiviert werden,
            anstatt Benutzer zu löschen.
        is_superuser:
          type: boolean
          title: Administrator-Status
          description: Legt fest, dass der Benutzer alle Berechtigungen hat, ohne
            diese einzeln zuweisen zu müssen.
        groups:
          type: array
          items:
            type: integer
            title: Gruppen
          title: Gruppen
          description: Die Gruppen, denen der Benutzer angehört. Ein Benutzer bekommt
            alle Berechtigungen dieser Gruppen.
        user_permissions:
          type: array
          items:
            type: string
            minLength: 1
      required:
      - username
    Workflow:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 256
        order:
          type: integer
        enabled:
          type: boolean
          title: Aktiviert
        triggers:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowTrigger'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowAction'
      required:
      - actions
      - id
      - name
      - triggers
    WorkflowAction:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        type:
          allOf:
          - $ref: '#/components/schemas/WorkflowActionTypeEnum'
          title: Arbeitsablauf-Aktionstyp
          minimum: 0
          maximum: 2147483647
        assign_title:
          type: string
          nullable: true
          title: Titel zuweisen
          description: Dokumenttitel zuweisen (muss eine Jinja2-Vorlage sein, siehe
            Dokumentation).
        assign_tags:
          type: array
          items:
            type: integer
            nullable: true
        assign_correspondent:
          type: integer
          nullable: true
        assign_document_type:
          type: integer
          nullable: true
        assign_storage_path:
          type: integer
          nullable: true
        assign_owner:
          type: integer
          nullable: true
          title: Diesen Eigentümer zuordnen
        assign_view_users:
          type: array
          items:
            type: integer
            title: Diesen Benutzern Anzeigeberechtigungen erteilen
          title: Diesen Benutzern Anzeigeberechtigungen erteilen
        assign_view_groups:
          type: array
          items:
            type: integer
            title: Diesen Gruppen Anzeigeberechtigungen erteilen
          title: Diesen Gruppen Anzeigeberechtigungen erteilen
        assign_change_users:
          type: array
          items:
            type: integer
            title: Diesen Benutzern Bearbeitungsberechtigungen erteilen
          title: Diesen Benutzern Bearbeitungsberechtigungen erteilen
        assign_change_groups:
          type: array
          items:
            type: integer
            title: Diesen Gruppen Bearbeitungsberechtigungen erteilen
          title: Diesen Gruppen Bearbeitungsberechtigungen erteilen
        assign_custom_fields:
          type: array
          items:
            type: integer
            title: Diese benutzerdefinierten Felder zuweisen
          title: Diese benutzerdefinierten Felder zuweisen
        assign_custom_fields_values:
          nullable: true
          title: Benutzerdefinierte Feldwerte
          description: Optionale Werte, die den benutzerdefinierten Feldern zugewiesen
            werden.
        remove_all_tags:
          type: boolean
          title: Alle Tags entfernen
        remove_tags:
          type: array
          items:
            type: integer
            title: Diese(n) Tag(s) entfernen
          title: Diese(n) Tag(s) entfernen
        remove_all_correspondents:
          type: boolean
          title: Alle Korrespondenten entfernen
        remove_correspondents:
          type: array
          items:
            type: integer
            title: Diese(n) Korrespondenten entfernen
          title: Diese(n) Korrespondenten entfernen
        remove_all_document_types:
          type: boolean
          title: Alle Dokumenttypen entfernen
        remove_document_types:
          type: array
          items:
            type: integer
            title: Diese(n) Dokumenttyp(en) entfernen
          title: Diese(n) Dokumenttyp(en) entfernen
        remove_all_storage_paths:
          type: boolean
          title: Alle Speicherpfade entfernen
        remove_storage_paths:
          type: array
          items:
            type: integer
            title: Diese(n) Speicherpfad(e) entfernen
          title: Diese(n) Speicherpfad(e) entfernen
        remove_custom_fields:
          type: array
          items:
            type: integer
            title: Diese benutzerdefinierten Felder entfernen
          title: Diese benutzerdefinierten Felder entfernen
        remove_all_custom_fields:
          type: boolean
          title: Alle benutzerdefinierten Felder entfernen
        remove_all_owners:
          type: boolean
          title: Alle Eigentümer entfernen
        remove_owners:
          type: array
          items:
            type: integer
            title: Diese(n) Eigentümer entfernen
          title: Diese(n) Eigentümer entfernen
        remove_all_permissions:
          type: boolean
          title: Alle Berechtigungen entfernen
        remove_view_users:
          type: array
          items:
            type: integer
            title: Anzeigeberechtigungen für diese Benutzer entfernen
          title: Anzeigeberechtigungen für diese Benutzer entfernen
        remove_view_groups:
          type: array
          items:
            type: integer
            title: Anzeigeberechtigungen für diese Gruppen entfernen
          title: Anzeigeberechtigungen für diese Gruppen entfernen
        remove_change_users:
          type: array
          items:
            type: integer
            title: Bearbeitungsberechtigungen für diese Benutzer entfernen
          title: Bearbeitungsberechtigungen für diese Benutzer entfernen
        remove_change_groups:
          type: array
          items:
            type: integer
            title: Bearbeitungsberechtigungen für diese Gruppen entfernen
          title: Bearbeitungsberechtigungen für diese Gruppen entfernen
        email:
          allOf:
          - $ref: '#/components/schemas/WorkflowActionEmail'
          nullable: true
        webhook:
          allOf:
          - $ref: '#/components/schemas/WorkflowActionWebhook'
          nullable: true
    WorkflowActionEmail:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        subject:
          type: string
          title: E-Mail-Betreff
          description: Der Betreff der E-Mail kann Platzhalter beinhalten, siehe Dokumentation.
          maxLength: 256
        body:
          type: string
          title: E-Mail-Inhalt
          description: Der Text der E-Mail kann Platzhalter beinhalten, siehe Dokumentation.
        to:
          type: string
          title: E-Mails an
          description: Die Empfänger-E-Mail-Adressen, kommagetrennt.
        include_document:
          type: boolean
          title: Dokument in E-Mail einbeziehen
      required:
      - body
      - subject
      - to
    WorkflowActionEmailRequest:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        subject:
          type: string
          minLength: 1
          title: E-Mail-Betreff
          description: Der Betreff der E-Mail kann Platzhalter beinhalten, siehe Dokumentation.
          maxLength: 256
        body:
          type: string
          minLength: 1
          title: E-Mail-Inhalt
          description: Der Text der E-Mail kann Platzhalter beinhalten, siehe Dokumentation.
        to:
          type: string
          minLength: 1
          title: E-Mails an
          description: Die Empfänger-E-Mail-Adressen, kommagetrennt.
        include_document:
          type: boolean
          title: Dokument in E-Mail einbeziehen
      required:
      - body
      - subject
      - to
    WorkflowActionRequest:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        type:
          allOf:
          - $ref: '#/components/schemas/WorkflowActionTypeEnum'
          title: Arbeitsablauf-Aktionstyp
          minimum: 0
          maximum: 2147483647
        assign_title:
          type: string
          nullable: true
          title: Titel zuweisen
          description: Dokumenttitel zuweisen (muss eine Jinja2-Vorlage sein, siehe
            Dokumentation).
        assign_tags:
          type: array
          items:
            type: integer
            nullable: true
        assign_correspondent:
          type: integer
          nullable: true
        assign_document_type:
          type: integer
          nullable: true
        assign_storage_path:
          type: integer
          nullable: true
        assign_owner:
          type: integer
          nullable: true
          title: Diesen Eigentümer zuordnen
        assign_view_users:
          type: array
          items:
            type: integer
            title: Diesen Benutzern Anzeigeberechtigungen erteilen
          title: Diesen Benutzern Anzeigeberechtigungen erteilen
        assign_view_groups:
          type: array
          items:
            type: integer
            title: Diesen Gruppen Anzeigeberechtigungen erteilen
          title: Diesen Gruppen Anzeigeberechtigungen erteilen
        assign_change_users:
          type: array
          items:
            type: integer
            title: Diesen Benutzern Bearbeitungsberechtigungen erteilen
          title: Diesen Benutzern Bearbeitungsberechtigungen erteilen
        assign_change_groups:
          type: array
          items:
            type: integer
            title: Diesen Gruppen Bearbeitungsberechtigungen erteilen
          title: Diesen Gruppen Bearbeitungsberechtigungen erteilen
        assign_custom_fields:
          type: array
          items:
            type: integer
            title: Diese benutzerdefinierten Felder zuweisen
          title: Diese benutzerdefinierten Felder zuweisen
        assign_custom_fields_values:
          nullable: true
          title: Benutzerdefinierte Feldwerte
          description: Optionale Werte, die den benutzerdefinierten Feldern zugewiesen
            werden.
        remove_all_tags:
          type: boolean
          title: Alle Tags entfernen
        remove_tags:
          type: array
          items:
            type: integer
            title: Diese(n) Tag(s) entfernen
          title: Diese(n) Tag(s) entfernen
        remove_all_correspondents:
          type: boolean
          title: Alle Korrespondenten entfernen
        remove_correspondents:
          type: array
          items:
            type: integer
            title: Diese(n) Korrespondenten entfernen
          title: Diese(n) Korrespondenten entfernen
        remove_all_document_types:
          type: boolean
          title: Alle Dokumenttypen entfernen
        remove_document_types:
          type: array
          items:
            type: integer
            title: Diese(n) Dokumenttyp(en) entfernen
          title: Diese(n) Dokumenttyp(en) entfernen
        remove_all_storage_paths:
          type: boolean
          title: Alle Speicherpfade entfernen
        remove_storage_paths:
          type: array
          items:
            type: integer
            title: Diese(n) Speicherpfad(e) entfernen
          title: Diese(n) Speicherpfad(e) entfernen
        remove_custom_fields:
          type: array
          items:
            type: integer
            title: Diese benutzerdefinierten Felder entfernen
          title: Diese benutzerdefinierten Felder entfernen
        remove_all_custom_fields:
          type: boolean
          title: Alle benutzerdefinierten Felder entfernen
        remove_all_owners:
          type: boolean
          title: Alle Eigentümer entfernen
        remove_owners:
          type: array
          items:
            type: integer
            title: Diese(n) Eigentümer entfernen
          title: Diese(n) Eigentümer entfernen
        remove_all_permissions:
          type: boolean
          title: Alle Berechtigungen entfernen
        remove_view_users:
          type: array
          items:
            type: integer
            title: Anzeigeberechtigungen für diese Benutzer entfernen
          title: Anzeigeberechtigungen für diese Benutzer entfernen
        remove_view_groups:
          type: array
          items:
            type: integer
            title: Anzeigeberechtigungen für diese Gruppen entfernen
          title: Anzeigeberechtigungen für diese Gruppen entfernen
        remove_change_users:
          type: array
          items:
            type: integer
            title: Bearbeitungsberechtigungen für diese Benutzer entfernen
          title: Bearbeitungsberechtigungen für diese Benutzer entfernen
        remove_change_groups:
          type: array
          items:
            type: integer
            title: Bearbeitungsberechtigungen für diese Gruppen entfernen
          title: Bearbeitungsberechtigungen für diese Gruppen entfernen
        email:
          allOf:
          - $ref: '#/components/schemas/WorkflowActionEmailRequest'
          nullable: true
        webhook:
          allOf:
          - $ref: '#/components/schemas/WorkflowActionWebhookRequest'
          nullable: true
    WorkflowActionTypeEnum:
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: |-
        * `1` - Zuordnung
        * `2` - Entfernung
        * `3` - E-Mail
        * `4` - Webhook
    WorkflowActionWebhook:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        url:
          type: string
          title: Webhook-URL
          description: Die Ziel-URL für die Benachrichtigung.
          maxLength: 256
        use_params:
          type: boolean
          title: Verwende Parameter
        as_json:
          type: boolean
          title: Als JSON senden
        params:
          nullable: true
          title: Webhook-Parameter
          description: Die Parameter, die mit der Webhook-URL gesendet werden sollen,
            wenn kein Inhalt verwendet wird.
        body:
          type: string
          nullable: true
          title: Webhook-Inhalt
          description: Der Inhalt, der mit der Webhook-URL gesendet werden soll, wenn
            Parameter nicht verwendet werden.
        headers:
          nullable: true
          title: Webhook-Kopfzeilen
          description: Die Kopfzeilen, die mit der Webhook-URL gesendet werden sollen.
        include_document:
          type: boolean
          title: Dokument in Webhook einbeziehen
      required:
      - url
    WorkflowActionWebhookRequest:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        url:
          type: string
          minLength: 1
          title: Webhook-URL
          description: Die Ziel-URL für die Benachrichtigung.
          maxLength: 256
        use_params:
          type: boolean
          title: Verwende Parameter
        as_json:
          type: boolean
          title: Als JSON senden
        params:
          nullable: true
          title: Webhook-Parameter
          description: Die Parameter, die mit der Webhook-URL gesendet werden sollen,
            wenn kein Inhalt verwendet wird.
        body:
          type: string
          nullable: true
          title: Webhook-Inhalt
          description: Der Inhalt, der mit der Webhook-URL gesendet werden soll, wenn
            Parameter nicht verwendet werden.
        headers:
          nullable: true
          title: Webhook-Kopfzeilen
          description: Die Kopfzeilen, die mit der Webhook-URL gesendet werden sollen.
        include_document:
          type: boolean
          title: Dokument in Webhook einbeziehen
      required:
      - url
    WorkflowRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 256
        order:
          type: integer
        enabled:
          type: boolean
          title: Aktiviert
        triggers:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowTriggerRequest'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowActionRequest'
      required:
      - actions
      - name
      - triggers
    WorkflowTrigger:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourcesEnum'
          default:
          - 1
          - 2
          - 3
        type:
          allOf:
          - $ref: '#/components/schemas/WorkflowTriggerTypeEnum'
          title: Trigger Type
        filter_path:
          type: string
          nullable: true
          title: Pfad filtern
          description: Nur Dokumente, die mit diesem Pfad (falls angegeben) übereinstimmen,
            verarbeiten. Platzhalter wie * sind erlaubt. Groß- und Kleinschreibung
            wird nicht beachtet.
          maxLength: 256
        filter_filename:
          type: string
          nullable: true
          title: Dateinamen filtern
          description: Nur Dokumente, die vollständig mit diesem Dateinamen (falls
            angegeben) übereinstimmen, verarbeiten. Platzhalter wie *.pdf oder *rechnung*
            sind erlaubt. Groß- und Kleinschreibung wird nicht beachtet.
          maxLength: 256
        filter_mailrule:
          type: integer
          nullable: true
          title: Dokumente aus dieser E-Mail-Regel filtern
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        filter_has_tags:
          type: array
          items:
            type: integer
            title: Hat diese(n) Tag(s)
          title: Hat diese(n) Tag(s)
        filter_has_all_tags:
          type: array
          items:
            type: integer
            title: Hat alle diese Tags
          title: Hat alle diese Tags
        filter_has_not_tags:
          type: array
          items:
            type: integer
            title: Hat diese Tags nicht
          title: Hat diese Tags nicht
        filter_custom_field_query:
          type: string
          nullable: true
          title: Filtern Benutzerdefinierte Feldabfrage
          description: JSON-kodierte Abfrage eines benutzerdefinierten Felds.
        filter_has_not_correspondents:
          type: array
          items:
            type: integer
            title: Hat diese Korrespondenten nicht
          title: Hat diese Korrespondenten nicht
        filter_has_not_document_types:
          type: array
          items:
            type: integer
            title: Hat diese Dokumenttypen nicht
          title: Hat diese Dokumenttypen nicht
        filter_has_not_storage_paths:
          type: array
          items:
            type: integer
            title: Hat diese Speicherpfade nicht
          title: Hat diese Speicherpfade nicht
        filter_has_correspondent:
          type: integer
          nullable: true
          title: Hat diesen Korrespondenten
        filter_has_document_type:
          type: integer
          nullable: true
          title: Hat diesen Dokumenttyp
        filter_has_storage_path:
          type: integer
          nullable: true
          title: Hat diesen Speicherpfad
        schedule_offset_days:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          title: Zeitplanversatz (Tage)
          description: Die Anzahl der Tage, um die der Zeitplanauslöser verschoben
            werden soll.
        schedule_is_recurring:
          type: boolean
          title: Zeitplan wiederholt sich
          description: Ob der Zeitplan wiederholt werden soll.
        schedule_recurring_interval_days:
          type: integer
          maximum: 2147483647
          minimum: 1
          title: Zeitplan-Wiederholungsverzögerung in Tagen
          description: Die Anzahl der Tage zwischen wiederkehrenden Zeitplanauslösern.
        schedule_date_field:
          allOf:
          - $ref: '#/components/schemas/ScheduleDateFieldEnum'
          title: Zeitplan-Datumsfeld
          description: |-
            Das zu prüfende Feld für einen Zeitplanauslöser.

            * `added` - Hinzugefügt
            * `created` - Ausgestellt
            * `modified` - Geändert
            * `custom_field` - Benutzerdefiniertes Feld
        schedule_date_custom_field:
          type: integer
          nullable: true
          title: Benutzerdefiniertes Zeitplan-Datumsfeld
      required:
      - type
    WorkflowTriggerMatchingAlgorithmEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
      description: |-
        * `0` - Keine
        * `1` - Irgendein Wort
        * `2` - Alle Wörter
        * `3` - Exakte Übereinstimmung
        * `4` - Regulärer Ausdruck
        * `5` - Ungenaues Wort
    WorkflowTriggerRequest:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourcesEnum'
          default:
          - 1
          - 2
          - 3
        type:
          allOf:
          - $ref: '#/components/schemas/WorkflowTriggerTypeEnum'
          title: Trigger Type
        filter_path:
          type: string
          nullable: true
          title: Pfad filtern
          description: Nur Dokumente, die mit diesem Pfad (falls angegeben) übereinstimmen,
            verarbeiten. Platzhalter wie * sind erlaubt. Groß- und Kleinschreibung
            wird nicht beachtet.
          maxLength: 256
        filter_filename:
          type: string
          nullable: true
          title: Dateinamen filtern
          description: Nur Dokumente, die vollständig mit diesem Dateinamen (falls
            angegeben) übereinstimmen, verarbeiten. Platzhalter wie *.pdf oder *rechnung*
            sind erlaubt. Groß- und Kleinschreibung wird nicht beachtet.
          maxLength: 256
        filter_mailrule:
          type: integer
          nullable: true
          title: Dokumente aus dieser E-Mail-Regel filtern
        matching_algorithm:
          allOf:
          - $ref: '#/components/schemas/WorkflowTriggerMatchingAlgorithmEnum'
          title: Zuweisungsalgorithmus
          minimum: 0
          maximum: 2147483647
        match:
          type: string
          title: Zuweisungsmuster
          maxLength: 256
        is_insensitive:
          type: boolean
          title: Groß-/Kleinschreibung irrelevant
        filter_has_tags:
          type: array
          items:
            type: integer
            title: Hat diese(n) Tag(s)
          title: Hat diese(n) Tag(s)
        filter_has_all_tags:
          type: array
          items:
            type: integer
            title: Hat alle diese Tags
          title: Hat alle diese Tags
        filter_has_not_tags:
          type: array
          items:
            type: integer
            title: Hat diese Tags nicht
          title: Hat diese Tags nicht
        filter_custom_field_query:
          type: string
          nullable: true
          title: Filtern Benutzerdefinierte Feldabfrage
          description: JSON-kodierte Abfrage eines benutzerdefinierten Felds.
        filter_has_not_correspondents:
          type: array
          items:
            type: integer
            title: Hat diese Korrespondenten nicht
          title: Hat diese Korrespondenten nicht
        filter_has_not_document_types:
          type: array
          items:
            type: integer
            title: Hat diese Dokumenttypen nicht
          title: Hat diese Dokumenttypen nicht
        filter_has_not_storage_paths:
          type: array
          items:
            type: integer
            title: Hat diese Speicherpfade nicht
          title: Hat diese Speicherpfade nicht
        filter_has_correspondent:
          type: integer
          nullable: true
          title: Hat diesen Korrespondenten
        filter_has_document_type:
          type: integer
          nullable: true
          title: Hat diesen Dokumenttyp
        filter_has_storage_path:
          type: integer
          nullable: true
          title: Hat diesen Speicherpfad
        schedule_offset_days:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          title: Zeitplanversatz (Tage)
          description: Die Anzahl der Tage, um die der Zeitplanauslöser verschoben
            werden soll.
        schedule_is_recurring:
          type: boolean
          title: Zeitplan wiederholt sich
          description: Ob der Zeitplan wiederholt werden soll.
        schedule_recurring_interval_days:
          type: integer
          maximum: 2147483647
          minimum: 1
          title: Zeitplan-Wiederholungsverzögerung in Tagen
          description: Die Anzahl der Tage zwischen wiederkehrenden Zeitplanauslösern.
        schedule_date_field:
          allOf:
          - $ref: '#/components/schemas/ScheduleDateFieldEnum'
          title: Zeitplan-Datumsfeld
          description: |-
            Das zu prüfende Feld für einen Zeitplanauslöser.

            * `added` - Hinzugefügt
            * `created` - Ausgestellt
            * `modified` - Geändert
            * `custom_field` - Benutzerdefiniertes Feld
        schedule_date_custom_field:
          type: integer
          nullable: true
          title: Benutzerdefiniertes Zeitplan-Datumsfeld
      required:
      - type
    WorkflowTriggerTypeEnum:
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: |-
        * `1` - Verarbeitung gestartet
        * `2` - Dokument hinzugefügt
        * `3` - Dokument aktualisiert
        * `4` - Geplant
  securitySchemes:
    PaperelessBasicAuthentication:
      type: http
      scheme: basic
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
externalDocs:
  description: Paperless-ngx API Documentation
  url: https://docs.paperless-ngx.com/api/