openapi: 3.0.4
servers:
  - url: https://{environment}.pigello.io
    variables:
      environment:
        default: dev.api
        enum:
          - dev.api
          - api
security:
  - customer_id: []
    application_id: []
    service_id: []
    service_version_id: []
    client_ct: []
    client_object_id: []
    client_secret: []
paths:
  /documents/filehandling/organizationuserfileaccessshare/:
    post:
      responses:
        '201':
          description: Successful creation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.organizationuserfileaccessshare'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Organizationuserfileaccessshare
        - Filehandling
      summary: Create 'Organizationuserfileaccessshare'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.organizationuserfileaccessshare'
  /documents/filehandling/organizationuserfileaccessshare/list/:
    post:
      responses:
        '201':
          description: Successful bulk create/update
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/documents.organizationuserfileaccessshare
        '400':
          $ref: '#/components/responses/invalid_list_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Organizationuserfileaccessshare
        - Filehandling
      summary: Bulk write 'Organizationuserfileaccessshare'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/documents.organizationuserfileaccessshare'
    get:
      responses:
        '200':
          description: Successful query
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/documents.organizationuserfileaccessshare
        '400':
          $ref: '#/components/responses/bad_query'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '404':
          $ref: '#/components/responses/not_found'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: _jsonl
          in: query
          required: false
          schema:
            type: boolean
        - name: _order_by
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          example: field_a,-field_b
        - name: _page
          in: query
          required: false
          schema:
            type: integer
            format: int32
            minimum: 1
            description: >-
              **Additional Validation Information:**


              This value must be set together with the following fields:
              `_page_size`
        - name: _page_size
          in: query
          required: false
          schema:
            type: integer
            format: int32
            description: |-
              **Additional Validation Information:**

              This value must be set together with the following fields: `_page`
        - name: _search
          in: query
          required: false
          schema:
            type: string
        - name: _slim
          in: query
          required: false
          schema:
            type: boolean
        - name: _statistics
          in: query
          required: false
          schema:
            type: boolean
        - name: global_realestates
          in: query
          required: false
          schema:
            type: array
            items: {}
        - name: global_segments
          in: query
          required: false
          schema:
            type: array
            items: {}
        - name: can_create
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
        - name: can_delete
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
        - name: can_update
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
        - name: created_at
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `gt`, Supports negation (via `!`): `True`


            Operator: `gte`, Supports negation (via `!`): `True`


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`


            Operator: `lt`, Supports negation (via `!`): `True`


            Operator: `lte`, Supports negation (via `!`): `True`
        - name: custom_id
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `contains`, Supports negation (via `!`): `True`


            Operator: `endswith`, Supports negation (via `!`): `True`


            Operator: `icontains`, Supports negation (via `!`): `True`


            Operator: `iendswith`, Supports negation (via `!`): `True`


            Operator: `iexact`, Supports negation (via `!`): `True`


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`


            Operator: `istartswith`, Supports negation (via `!`): `True`


            Operator: `startswith`, Supports negation (via `!`): `True`
        - name: file_access_share
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
        - name: id
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
        - name: organization
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
        - name: user
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
      tags:
        - Organizationuserfileaccessshare
        - Filehandling
      summary: List 'Organizationuserfileaccessshare'
  /documents/filehandling/organizationuserfileaccessshare/{pk}/:
    patch:
      responses:
        '200':
          description: Successful update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.organizationuserfileaccessshare'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Organizationuserfileaccessshare
        - Filehandling
      summary: Update 'Organizationuserfileaccessshare'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.organizationuserfileaccessshare'
    delete:
      responses:
        '204':
          description: Successful deletion
        '400':
          $ref: '#/components/responses/invalid_object_state'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Organizationuserfileaccessshare
        - Filehandling
      summary: Delete 'Organizationuserfileaccessshare'
    get:
      responses:
        '200':
          description: Successful selection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.organizationuserfileaccessshare'
        '400':
          $ref: '#/components/responses/bad_query'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '404':
          $ref: '#/components/responses/not_found'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Organizationuserfileaccessshare
        - Filehandling
      summary: Get 'Organizationuserfileaccessshare'
  /documents/filehandling/file/list/:
    post:
      responses:
        '201':
          description: Successful bulk create/update
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/documents.file'
        '400':
          $ref: '#/components/responses/invalid_list_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - File
      summary: Bulk write 'File'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/documents.file'
  /documents/filehandling/file/:
    post:
      responses:
        '201':
          description: Successful creation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.file'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - File
      summary: Create 'File'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.file'
  /documents/filehandling/file/{pk}/:
    delete:
      responses:
        '204':
          description: Successful deletion
        '400':
          $ref: '#/components/responses/invalid_object_state'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - File
      summary: Delete 'File'
    patch:
      responses:
        '200':
          description: Successful update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.file'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - File
      summary: Update 'File'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.file'
  /documents/signing/signabledocumentparty/list/:
    post:
      responses:
        '201':
          description: Successful bulk create/update
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/documents.signabledocumentparty'
        '400':
          $ref: '#/components/responses/invalid_list_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Signabledocumentparty
        - Signing
      summary: Bulk write 'Signabledocumentparty'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/documents.signabledocumentparty'
  /documents/signing/signabledocumentparty/:
    post:
      responses:
        '201':
          description: Successful creation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.signabledocumentparty'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Signabledocumentparty
        - Signing
      summary: Create 'Signabledocumentparty'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.signabledocumentparty'
  /documents/signing/signabledocumentparty/{pk}/:
    delete:
      responses:
        '204':
          description: Successful deletion
        '400':
          $ref: '#/components/responses/invalid_object_state'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Signabledocumentparty
        - Signing
      summary: Delete 'Signabledocumentparty'
    patch:
      responses:
        '200':
          description: Successful update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.signabledocumentparty'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Signabledocumentparty
        - Signing
      summary: Update 'Signabledocumentparty'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.signabledocumentparty'
    get:
      responses:
        '200':
          description: Successful selection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.signabledocumentparty'
        '400':
          $ref: '#/components/responses/bad_query'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '404':
          $ref: '#/components/responses/not_found'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Signabledocumentparty
        - Signing
      summary: Get 'Signabledocumentparty'
  /documents/signing/signabledocument/list/:
    post:
      responses:
        '201':
          description: Successful bulk create/update
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/documents.signabledocument'
        '400':
          $ref: '#/components/responses/invalid_list_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Signabledocument
        - Signing
      summary: Bulk write 'Signabledocument'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/documents.signabledocument'
  /documents/signing/signabledocument/{pk}/:
    get:
      responses:
        '200':
          description: Successful selection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.signabledocument'
        '400':
          $ref: '#/components/responses/bad_query'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '404':
          $ref: '#/components/responses/not_found'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Signabledocument
        - Signing
      summary: Get 'Signabledocument'
    delete:
      responses:
        '204':
          description: Successful deletion
        '400':
          $ref: '#/components/responses/invalid_object_state'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Signabledocument
        - Signing
      summary: Delete 'Signabledocument'
    patch:
      responses:
        '200':
          description: Successful update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.signabledocument'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Signabledocument
        - Signing
      summary: Update 'Signabledocument'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.signabledocument'
  /documents/signing/signabledocument/:
    post:
      responses:
        '201':
          description: Successful creation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.signabledocument'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Signabledocument
        - Signing
      summary: Create 'Signabledocument'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.signabledocument'
  /documents/filehandling/folder/list/:
    post:
      responses:
        '201':
          description: Successful bulk create/update
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/documents.folder'
        '400':
          $ref: '#/components/responses/invalid_list_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Folder
        - Filehandling
      summary: Bulk write 'Folder'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/documents.folder'
  /documents/filehandling/folder/{pk}/:
    patch:
      responses:
        '200':
          description: Successful update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.folder'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Folder
        - Filehandling
      summary: Update 'Folder'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.folder'
    delete:
      responses:
        '204':
          description: Successful deletion
        '400':
          $ref: '#/components/responses/invalid_object_state'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Folder
        - Filehandling
      summary: Delete 'Folder'
  /documents/filehandling/folder/:
    post:
      responses:
        '201':
          description: Successful creation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.folder'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Folder
        - Filehandling
      summary: Create 'Folder'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.folder'
  /documents/signing/signabledocumentpartyfield/:
    post:
      responses:
        '201':
          description: Successful creation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.signabledocumentpartyfield'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Signabledocumentpartyfield
        - Signing
      summary: Create 'Signabledocumentpartyfield'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.signabledocumentpartyfield'
  /documents/signing/signabledocumentpartyfield/list/:
    post:
      responses:
        '201':
          description: Successful bulk create/update
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/documents.signabledocumentpartyfield'
        '400':
          $ref: '#/components/responses/invalid_list_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Signabledocumentpartyfield
        - Signing
      summary: Bulk write 'Signabledocumentpartyfield'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/documents.signabledocumentpartyfield'
  /documents/signing/signabledocumentpartyfield/{pk}/:
    delete:
      responses:
        '204':
          description: Successful deletion
        '400':
          $ref: '#/components/responses/invalid_object_state'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Signabledocumentpartyfield
        - Signing
      summary: Delete 'Signabledocumentpartyfield'
    patch:
      responses:
        '200':
          description: Successful update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.signabledocumentpartyfield'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Signabledocumentpartyfield
        - Signing
      summary: Update 'Signabledocumentpartyfield'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.signabledocumentpartyfield'
    get:
      responses:
        '200':
          description: Successful selection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.signabledocumentpartyfield'
        '400':
          $ref: '#/components/responses/bad_query'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '404':
          $ref: '#/components/responses/not_found'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Signabledocumentpartyfield
        - Signing
      summary: Get 'Signabledocumentpartyfield'
  /documents/filehandling/fileaccessshare/{pk}/:
    patch:
      responses:
        '200':
          description: Successful update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.fileaccessshare'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Fileaccessshare
        - Filehandling
      summary: Update 'Fileaccessshare'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.fileaccessshare'
    delete:
      responses:
        '204':
          description: Successful deletion
        '400':
          $ref: '#/components/responses/invalid_object_state'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Fileaccessshare
        - Filehandling
      summary: Delete 'Fileaccessshare'
    get:
      responses:
        '200':
          description: Successful selection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.fileaccessshare'
        '400':
          $ref: '#/components/responses/bad_query'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '404':
          $ref: '#/components/responses/not_found'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Fileaccessshare
        - Filehandling
      summary: Get 'Fileaccessshare'
  /documents/filehandling/fileaccessshare/list/:
    post:
      responses:
        '201':
          description: Successful bulk create/update
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/documents.fileaccessshare'
        '400':
          $ref: '#/components/responses/invalid_list_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Fileaccessshare
        - Filehandling
      summary: Bulk write 'Fileaccessshare'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/documents.fileaccessshare'
    get:
      responses:
        '200':
          description: Successful query
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/documents.fileaccessshare'
        '400':
          $ref: '#/components/responses/bad_query'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '404':
          $ref: '#/components/responses/not_found'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: _jsonl
          in: query
          required: false
          schema:
            type: boolean
        - name: _order_by
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          example: field_a,-field_b
        - name: _page
          in: query
          required: false
          schema:
            type: integer
            format: int32
            minimum: 1
            description: >-
              **Additional Validation Information:**


              This value must be set together with the following fields:
              `_page_size`
        - name: _page_size
          in: query
          required: false
          schema:
            type: integer
            format: int32
            description: |-
              **Additional Validation Information:**

              This value must be set together with the following fields: `_page`
        - name: _search
          in: query
          required: false
          schema:
            type: string
        - name: _slim
          in: query
          required: false
          schema:
            type: boolean
        - name: _statistics
          in: query
          required: false
          schema:
            type: boolean
        - name: global_realestates
          in: query
          required: false
          schema:
            type: array
            items: {}
        - name: global_segments
          in: query
          required: false
          schema:
            type: array
            items: {}
        - name: created_at
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `gt`, Supports negation (via `!`): `True`


            Operator: `gte`, Supports negation (via `!`): `True`


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`


            Operator: `lt`, Supports negation (via `!`): `True`


            Operator: `lte`, Supports negation (via `!`): `True`
        - name: custom_id
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `contains`, Supports negation (via `!`): `True`


            Operator: `endswith`, Supports negation (via `!`): `True`


            Operator: `icontains`, Supports negation (via `!`): `True`


            Operator: `iendswith`, Supports negation (via `!`): `True`


            Operator: `iexact`, Supports negation (via `!`): `True`


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`


            Operator: `istartswith`, Supports negation (via `!`): `True`


            Operator: `startswith`, Supports negation (via `!`): `True`
        - name: id
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
        - name: organization
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
      tags:
        - Fileaccessshare
        - Filehandling
      summary: List 'Fileaccessshare'
  /documents/filehandling/fileaccessshare/:
    post:
      responses:
        '201':
          description: Successful creation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.fileaccessshare'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Fileaccessshare
        - Filehandling
      summary: Create 'Fileaccessshare'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.fileaccessshare'
  /documents/filehandling/publicfile/list/:
    get:
      responses:
        '200':
          description: Successful query
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/documents.publicfile'
        '400':
          $ref: '#/components/responses/bad_query'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '404':
          $ref: '#/components/responses/not_found'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: _jsonl
          in: query
          required: false
          schema:
            type: boolean
        - name: _order_by
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          example: field_a,-field_b
        - name: _page
          in: query
          required: false
          schema:
            type: integer
            format: int32
            minimum: 1
            description: >-
              **Additional Validation Information:**


              This value must be set together with the following fields:
              `_page_size`
        - name: _page_size
          in: query
          required: false
          schema:
            type: integer
            format: int32
            description: |-
              **Additional Validation Information:**

              This value must be set together with the following fields: `_page`
        - name: _search
          in: query
          required: false
          schema:
            type: string
        - name: _slim
          in: query
          required: false
          schema:
            type: boolean
        - name: _statistics
          in: query
          required: false
          schema:
            type: boolean
        - name: global_realestates
          in: query
          required: false
          schema:
            type: array
            items: {}
        - name: global_segments
          in: query
          required: false
          schema:
            type: array
            items: {}
        - name: created_at
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `gt`, Supports negation (via `!`): `True`


            Operator: `gte`, Supports negation (via `!`): `True`


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`


            Operator: `lt`, Supports negation (via `!`): `True`


            Operator: `lte`, Supports negation (via `!`): `True`
        - name: custom_id
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `contains`, Supports negation (via `!`): `True`


            Operator: `endswith`, Supports negation (via `!`): `True`


            Operator: `icontains`, Supports negation (via `!`): `True`


            Operator: `iendswith`, Supports negation (via `!`): `True`


            Operator: `iexact`, Supports negation (via `!`): `True`


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`


            Operator: `istartswith`, Supports negation (via `!`): `True`


            Operator: `startswith`, Supports negation (via `!`): `True`
        - name: id
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
        - name: organization
          in: query
          required: false
          schema: {}
          description: >-
            Filter can be negated by adding a `!` to the end of the parameter
            name.






            **Additional operators:**


            Operator: `in`, Supports negation (via `!`): `True`


            Operator: `isnull`, Supports negation (via `!`): `True`
      tags:
        - Publicfile
        - Filehandling
      summary: List 'Publicfile'
    post:
      responses:
        '201':
          description: Successful bulk create/update
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/documents.publicfile'
        '400':
          $ref: '#/components/responses/invalid_list_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Publicfile
        - Filehandling
      summary: Bulk write 'Publicfile'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/documents.publicfile'
  /documents/filehandling/publicfile/{pk}/:
    get:
      responses:
        '200':
          description: Successful selection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.publicfile'
        '400':
          $ref: '#/components/responses/bad_query'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '404':
          $ref: '#/components/responses/not_found'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Publicfile
        - Filehandling
      summary: Get 'Publicfile'
    delete:
      responses:
        '204':
          description: Successful deletion
        '400':
          $ref: '#/components/responses/invalid_object_state'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters:
        - name: pk
          in: path
          required: true
          schema:
            type: string
            writeOnly: true
      tags:
        - Publicfile
        - Filehandling
      summary: Delete 'Publicfile'
  /documents/filehandling/publicfile/:
    post:
      responses:
        '201':
          description: Successful creation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents.publicfile'
        '400':
          $ref: '#/components/responses/invalid_object_payload'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/permission_denied'
        '429':
          $ref: '#/components/responses/rate_limit_exceeded'
      parameters: []
      tags:
        - Publicfile
        - Filehandling
      summary: Create 'Publicfile'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documents.publicfile'
components:
  securitySchemes:
    customer_id:
      type: apiKey
      in: header
      name: X-PIGELLO-CUSTOMER-ID
    application_id:
      type: apiKey
      in: header
      name: X-PIGELLO-APPLICATION-ID
    service_id:
      type: apiKey
      in: header
      name: X-PIGELLO-SERVICE-ID
    service_version_id:
      type: apiKey
      in: header
      name: X-PIGELLO-SERVICE-VERSION-ID
    client_ct:
      type: apiKey
      in: header
      name: X-PIGELLO-CLIENT-CT
    client_object_id:
      type: apiKey
      in: header
      name: X-PIGELLO-CLIENT-ENTITY
    client_secret:
      type: apiKey
      in: header
      name: X-PIGELLO-CLIENT-SECRET
  responses:
    not_found:
      description: Resource not found
    bad_query:
      description: Bad query/selection
    invalid_object_payload:
      description: Invalid payload
      content:
        application/json:
          schema: {}
    invalid_list_payload:
      description: Invalid payload
      content:
        application/json:
          schema:
            type: array
            items: {}
    invalid_object_state:
      description: Invalid state of object
      content:
        application/json:
          schema: {}
    permission_denied:
      description: Permission Denied
    unauthorized:
      description: Unauthorized
    rate_limit_exceeded:
      description: Rate limit exceeded
  schemas:
    documents.organizationuserfileaccessshare:
      properties:
        user:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: false
          title: Organizationuser
        organization:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Organization
        can_update:
          type: boolean
          nullable: false
        file_access_share:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: false
          title: Fileaccessshare
        can_create:
          type: boolean
          nullable: false
        can_delete:
          type: boolean
          nullable: false
        custom_id:
          type: string
          maxLength: 128
          nullable: true
        id:
          type: string
          format: uuid
          nullable: false
          readOnly: true
          description: |-
            **Additional Validation Information:**

            Must be unique
        created_at:
          type: string
          format: date-time
          nullable: false
          readOnly: true
      type: object
      required:
        - user
        - can_update
        - file_access_share
        - can_create
        - can_delete
        - id
      description: 'Content Type: `documents.organizationuserfileaccessshare`'
    documents.file:
      properties:
        folder:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Folder
        created_at:
          type: string
          format: date-time
          nullable: false
          readOnly: true
        contains_personal_data:
          type: boolean
          nullable: true
        private:
          type: boolean
          nullable: false
        notation_content_type:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: false
          title: Contenttype
          description: >-
            **Additional Validation Information:**


            This value must be set together with the following fields:
            `notation_object_id`
        access_share:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Fileaccessshare
        organization:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Organization
        notation_object_id:
          type: string
          format: uuid
          nullable: false
          description: >-
            **Additional Validation Information:**


            This value must be set together with the following fields:
            `notation_content_type`
        custom_id:
          type: string
          maxLength: 128
          nullable: true
        original_name:
          type: string
          minLength: 1
          maxLength: 255
          nullable: false
        created_by:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          readOnly: true
          title: Organizationuser
        id:
          type: string
          format: uuid
          nullable: false
          readOnly: true
          description: |-
            **Additional Validation Information:**

            Must be unique
        content:
          type: object
          properties:
            name:
              type: string
              description: wanted filename of the file
            md5_hash:
              type: string
              description: base64 encoded md5hash of the file
            get:
              type: string
              format: url
            post:
              type: object
              properties:
                url:
                  type: string
                  format: url
                fields:
                  type: object
                  additionalProperties: true
          nullable: false
      type: object
      required:
        - notation_content_type
        - notation_object_id
        - original_name
        - id
        - content
      description: 'Content Type: `documents.file`'
    documents.signabledocumentparty:
      properties:
        answer_authentication_method:
          type: integer
          format: int32
          minimum: -2147483648
          maximum: 2147483647
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: false
          readOnly: true
        sub_tenant:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Subtenant
          description: >-
            **Additional Validation Information:**


            This value can't bet set, when any of the following fields are set:
            `organization_user`, `tenant`
        sent_time:
          type: string
          format: date-time
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value must be set in an proper order, in relation to the
            following fields: `opened_time`, `signed_time`, `rejected_time`
        rejection_reason:
          type: string
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value requires that the following fields are also set:
            `rejected_time`
        individually_finished_distribution_method:
          type: integer
          format: int32
          minimum: -2147483648
          maximum: 2147483647
          enum:
            - 0
            - 1
            - 2
            - 3
          nullable: true
        finished_data:
          type: object
          properties:
            name:
              type: string
              description: wanted filename of the file
            md5_hash:
              type: string
              description: base64 encoded md5hash of the file
            get:
              type: string
              format: url
            post:
              type: object
              properties:
                url:
                  type: string
                  format: url
                fields:
                  type: object
                  additionalProperties: true
          nullable: true
          writeOnly: true
        opened_time:
          type: string
          format: date-time
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value must be set in an proper order, in relation to the
            following fields: `signed_time`, `rejected_time`, `sent_time`
        finished_with_ip:
          type: string
          format: ipv6,ipv4
          nullable: true
        order:
          type: integer
          format: int32
          minimum: -2147483648
          maximum: 2147483647
          nullable: false
        fully_finished_distribution_method:
          type: integer
          format: int32
          minimum: -2147483648
          maximum: 2147483647
          enum:
            - 0
            - 1
            - 2
            - 3
          nullable: true
        organization_user:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Organizationuser
          description: >-
            **Additional Validation Information:**


            This value can't bet set, when any of the following fields are set:
            `tenant`, `sub_tenant`
        organization:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Organization
        rejected_time:
          type: string
          format: date-time
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value can't bet set, when any of the following fields are set:
            `signed_time`


            This value must be set in an proper order, in relation to the
            following fields: `sent_time`, `opened_time`


            This value requires that the following fields are also set:
            `started_time`
        tenant:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Tenant
          description: >-
            **Additional Validation Information:**


            This value can't bet set, when any of the following fields are set:
            `organization_user`, `sub_tenant`
        fallback_distribution_method:
          type: integer
          format: int32
          minimum: -2147483648
          maximum: 2147483647
          enum:
            - 0
            - 1
            - 2
            - 3
          nullable: true
        role:
          type: integer
          format: int32
          minimum: -2147483648
          maximum: 2147483647
          enum:
            - 0
            - 1
            - 2
          nullable: false
        id:
          type: string
          format: uuid
          nullable: false
          readOnly: true
          description: |-
            **Additional Validation Information:**

            Must be unique
        document:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: false
          title: Signabledocument
        signed_time:
          type: string
          format: date-time
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value can't bet set, when any of the following fields are set:
            `rejected_time`


            This value must be set in an proper order, in relation to the
            following fields: `opened_time`, `sent_time`


            This value requires that the following fields are also set:
            `started_time`
        started_time:
          type: string
          format: date-time
          nullable: true
        invite_distribution_method:
          type: integer
          format: int32
          minimum: -2147483648
          maximum: 2147483647
          enum:
            - 0
            - 1
            - 2
            - 3
          nullable: true
        view_authentication_method:
          type: integer
          format: int32
          minimum: -2147483648
          maximum: 2147483647
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
          nullable: true
        custom_id:
          type: string
          maxLength: 128
          nullable: true
        finished_with_user_agent:
          type: string
          nullable: true
      type: object
      required:
        - role
        - id
        - document
      description: 'Content Type: `documents.signabledocumentparty`'
    documents.signabledocument:
      properties:
        content_type:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Contenttype
        is_template:
          type: boolean
          nullable: false
        data_to_sign:
          type: object
          properties:
            name:
              type: string
              description: wanted filename of the file
            md5_hash:
              type: string
              description: base64 encoded md5hash of the file
            get:
              type: string
              format: url
            post:
              type: object
              properties:
                url:
                  type: string
                  format: url
                fields:
                  type: object
                  additionalProperties: true
          nullable: true
          readOnly: true
        attached_to:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Signabledocument
        customer_columns:
          readOnly: true
        signed_time:
          type: string
          format: date-time
          nullable: true
        interpret_text_as_markdown:
          type: boolean
          nullable: false
        finished_data:
          type: object
          properties:
            name:
              type: string
              description: wanted filename of the file
            md5_hash:
              type: string
              description: base64 encoded md5hash of the file
            get:
              type: string
              format: url
            post:
              type: object
              properties:
                url:
                  type: string
                  format: url
                fields:
                  type: object
                  additionalProperties: true
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value requires that the following fields are also set:
            `signing_started_time`
        document_file:
          type: object
          properties:
            name:
              type: string
              description: wanted filename of the file
            md5_hash:
              type: string
              description: base64 encoded md5hash of the file
            get:
              type: string
              format: url
            post:
              type: object
              properties:
                url:
                  type: string
                  format: url
                fields:
                  type: object
                  additionalProperties: true
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value can't bet set, when any of the following fields are set:
            `text_content`
        days_to_sign:
          type: integer
          format: int32
          minimum: 1
          maximum: 2147483647
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value must be set with a proper magnitude, in relation to the
            following fields: `days_to_remind`
        created_at:
          type: string
          format: date-time
          nullable: false
          readOnly: true
        name:
          type: string
          maxLength: 255
          nullable: false
        object_id:
          type: string
          format: uuid
          nullable: true
        signing_initiated:
          type: boolean
          nullable: false
        category:
          type: integer
          format: int32
          minimum: -2147483648
          maximum: 2147483647
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
          nullable: true
        organization:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Organization
        signing_started_time:
          type: string
          format: date-time
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value must be set in an proper order, in relation to the
            following fields: `signing_aborted_time`
        custom_id:
          type: string
          maxLength: 128
          nullable: true
        confirmation_message:
          type: string
          nullable: true
        days_to_remind:
          type: integer
          format: int32
          minimum: 1
          maximum: 2147483647
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value must be set with a proper magnitude, in relation to the
            following fields: `days_to_sign`
        rejected_time:
          type: string
          format: date-time
          nullable: true
        tags:
          readOnly: true
        external_sign_engine:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Integrationuseragent
        formatted_data_to_sign:
          type: object
          properties:
            name:
              type: string
              description: wanted filename of the file
            md5_hash:
              type: string
              description: base64 encoded md5hash of the file
            get:
              type: string
              format: url
            post:
              type: object
              properties:
                url:
                  type: string
                  format: url
                fields:
                  type: object
                  additionalProperties: true
          nullable: true
        text_content:
          type: string
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value can't bet set, when any of the following fields are set:
            `document_file`
        invitation_message:
          type: string
          nullable: true
        signing_aborted_time:
          type: string
          format: date-time
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value must be set in an proper order, in relation to the
            following fields: `signing_started_time`
        id:
          type: string
          format: uuid
          nullable: false
          readOnly: true
          description: |-
            **Additional Validation Information:**

            Must be unique
      type: object
      required:
        - name
        - id
      description: 'Content Type: `documents.signabledocument`'
    documents.folder:
      properties:
        folder:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Folder
        created_by:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          readOnly: true
          title: Organizationuser
        id:
          type: string
          format: uuid
          nullable: false
          readOnly: true
          description: |-
            **Additional Validation Information:**

            Must be unique
        custom_id:
          type: string
          maxLength: 128
          nullable: true
        contains_files_with_personal_data:
          type: boolean
          nullable: false
        notation_content_type:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: false
          title: Contenttype
          description: >-
            **Additional Validation Information:**


            This value must be set together with the following fields:
            `notation_object_id`
        organization:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Organization
        access_share:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Fileaccessshare
        created_at:
          type: string
          format: date-time
          nullable: false
          readOnly: true
        private:
          type: boolean
          nullable: false
        name:
          type: string
          minLength: 3
          maxLength: 255
          nullable: false
        notation_object_id:
          type: string
          format: uuid
          nullable: false
          description: >-
            **Additional Validation Information:**


            This value must be set together with the following fields:
            `notation_content_type`
        color:
          type: string
          maxLength: 7
          pattern: '''^(?:[0-9a-fA-F]{3}){1,2}$'''
          nullable: true
      type: object
      required:
        - id
        - contains_files_with_personal_data
        - notation_content_type
        - name
        - notation_object_id
      description: 'Content Type: `documents.folder`'
    documents.signabledocumentpartyfield:
      properties:
        interpret_text_as_markdown:
          type: boolean
          nullable: false
        position_y_rel:
          type: number
          format: float
          maximum: 1
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value must be set together with the following fields:
            `position_x_rel`, `font_size_rel`
        font_size_rel:
          type: number
          format: float
          maximum: 1
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value must be set together with the following fields:
            `position_x_rel`, `position_y_rel`
        autofill_value_instruction:
          type: string
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value requires that the following fields are also set:
            `autofill_field_identifier`
        rotate_placement:
          type: integer
          format: int32
          minimum: -360
          maximum: 360
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value requires that the following fields are also set:
            `position_x_rel`
        organization:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Organization
        autofill_field_identifier:
          type: string
          maxLength: 255
          enum:
            - outdoorsection__landlord_custom_id
            - subtenant__email
            - parkingspot__address.get_full_street_value
            - inspectionerrand__protocol_signed_time
            - generalerrand_organization_user_performers__custom_id
            - sub_tenant_signable_party__corporate_name
            - sub_tenant_signable_party__previous_address.attention
            - inspectionerrand_tenants__last_name
            - industrialpremises__address.get_verbose_value
            - organization_user_party__communication_name
            - parkingspot__landlord_custom_id
            - bi_tenants_contract
            - inspectionerrand__space.address.street_number
            - inspectionerrand_tenants__future_address.city
            - apartment__terms.heat_supply
            - bi_tenants_contract__current_registered_address.attention
            - inspectionerrand_performers__profile_picture
            - tenant__sni_number
            - tenant__future_address.attention
            - notification_recipient__ssn
            - apartment__address.street_number
            - company_custom
            - parkingspot__address.get_verbose_value
            - tenant_signable_party__is_company
            - external_party__ssn
            - external_party__org_no
            - generalerrand__priority
            - apartment__landlord_custom_id
            - apartment__address.city
            - tenant__is_company
            - subtenant__current_registered_address.street_number
            - subtenant__first_name
            - tenant__previous_address.care_of
            - outdoorsection__address.street_number
            - subtenant__current_registered_address.country
            - external_party__previous_address.city
            - notification_recipient__org_no
            - industrialpremises__address.street
            - tenant__popular_name
            - subtenant__future_address.postal_code
            - generalerrand__address.city
            - community
            - sub_tenant_signable_party__future_address.attention
            - tenant_signable_party__future_address.street
            - parkingspot__address.attention
            - outdoorsection__address.country
            - apartment__terms.cold_water_supply
            - bi_tenants_contract__future_address.street_number
            - tenant_signable_party__phone_number
            - sub_tenant_signable_party__custom_id
            - apartment__address.postal_code
            - bi_tenants_contract__future_address.postal_code
            - external_party__current_registered_address.street_number
            - external_party__communication_name
            - parkingspot
            - tenant__previous_address.get_verbose_value
            - inspectionerrand_performers__ssn
            - inspectionerrand_tenants__previous_address.city
            - invoice__invoice_number
            - realestate
            - external_party__current_registered_address.postal_code
            - external_party__current_registered_address.street
            - inspectionerrand_tenants__current_registered_address.street
            - notification_recipient__application_access_url
            - bi_tenants_contract__ssn
            - inspectionerrand_tenants__current_registered_address.city
            - tenant_signable_party__popular_name
            - tenant__current_registered_address.care_of
            - inspectionerrand_tenants__ssn
            - organization_user_party__last_name
            - space_custom__category
            - external_party__application_access_url
            - tenant_signable_party__current_registered_address.city
            - tenant_signable_party__future_address.city
            - external_party__full_name
            - generalerrand__has_pets
            - indoor_space_custom__floors
            - subtenant__communication_name
            - tenant_signable_party__future_address.postal_code
            - parkingspot__address.street_number
            - external_party__previous_address.attention
            - external_party__first_name
            - apartment__address.attention
            - external_party__current_registered_address.get_verbose_value
            - bi_tenants_contract__last_name
            - tenant__future_address.street_number
            - sub_tenant_signable_party__communication_name
            - subtenant__previous_address.get_verbose_value
            - invoice__due_date
            - tenant__full_name
            - sub_tenant_signable_party__current_registered_address.care_of
            - subtenant__current_registered_address.care_of
            - bi_tenants_contract__current_registered_address.city
            - tenant_signable_party__future_address.country
            - inspectionerrand_performers__first_name
            - inspectionerrand_tenants__future_address.street_number
            - inspectionerrand__planned_done_time
            - inspectionerrand__id_number
            - tenant_signable_party__future_address.attention
            - parkingspot__bi_area
            - >-
              tenant_signable_party__current_registered_address.get_verbose_value
            - inspectionerrand_tenants
            - sub_tenant_signable_party__future_address.care_of
            - tenant__current_registered_address.city
            - external_party__future_address.attention
            - subtenant__popular_name
            - generalerrand__address.street
            - external_party__profile_picture
            - inspectionerrand_tenants__birth_date
            - sub_tenant_signable_party__ssn
            - inspectionerrand_performers__communication_name
            - subtenant__previous_address.country
            - tenant_signable_party
            - >-
              sub_tenant_signable_party__current_registered_address.street_number
            - sub_tenant_signable_party__org_no
            - tenant_signable_party__previous_address.attention
            - organization_user_party
            - tenant__application_access_user_segments
            - inspectionerrand_tenants__first_name
            - tenant_signable_party__current_registered_address.street_number
            - external_party__current_registered_address.country
            - generalerrand__description
            - tenant__previous_address.street
            - company__org_no
            - bi_tenants_contract__previous_address.street
            - contract__renewed_to
            - inspectionerrand_performers__full_name
            - external_party__previous_address.street
            - outdoorsection__address.street
            - generalerrand_reporter__application_access_user_segments
            - bi_tenants_contract__current_registered_address.care_of
            - notification_recipient__profile_picture
            - tenant__current_registered_address.get_verbose_value
            - anonymousgeneralerrandlink
            - sub_tenant_signable_party__sni_number
            - inspectionerrand_tenants__previous_address.get_verbose_value
            - invoice__main_period_start
            - inspectionerrand_tenants__future_address.country
            - tenant_signable_party__previous_address.country
            - sub_tenant_signable_party__phone_number
            - generalerrand__id_number
            - sub_tenant_signable_party__future_address.postal_code
            - tenant_signable_party__previous_address.care_of
            - generalerrand__is_warranty
            - industrialpremises__tempered_area
            - subtenant__future_address.country
            - generalerrand__errand_type.name
            - subtenant__phone_number
            - bi_tenants_contract__future_address.city
            - tenant
            - invoice_custom__title
            - organization_user_party__application_access_url
            - organization_user_party__first_name
            - subtenant__current_registered_address.attention
            - bi_tenants_contract__future_address.attention
            - tenant__future_address.country
            - invoice__main_period_end
            - sub_tenant_signable_party__current_registered_address.country
            - contract__get_first_invoice_date
            - generalerrand__errand_sub_type.name
            - external_party__previous_address.get_verbose_value
            - generalerrand__address.country
            - bi_tenants_contract__application_access_user_segments
            - subtenant__org_no
            - apartment__address.get_full_street_value
            - realestate__name
            - contract__start_date
            - inspectionerrand_performers__birth_date
            - basecontract_custom
            - bi_tenants_contract__current_registered_address.street_number
            - tenant__future_address.care_of
            - notification_recipient__custom_id
            - inspectionerrand_tenants__previous_address.country
            - industrialpremises__popular_name
            - contract__signed_time
            - bi_tenants_contract__is_company
            - tenant__previous_address.attention
            - generalerrand_reporter__communication_name
            - outdoorsection__address.get_full_street_value
            - inspectionerrand_tenants__future_address.postal_code
            - inspectionerrand_tenants__application_access_user_segments
            - contract__counterpart_notification_interval_weeks
            - contract__renew_interval_weeks
            - tenant__current_registered_address.attention
            - sub_tenant_signable_party__last_name
            - external_party__current_registered_address.city
            - subtenant__previous_address.street
            - organization_user_party__birth_date
            - invoice__total_vat
            - outdoorsection__usable_area
            - bi_tenants_contract__current_registered_address.street
            - inspectionerrand_performers__phone_number
            - sub_tenant_signable_party__application_access_url
            - industrialpremises__address.attention
            - inspectionerrand_tenants__future_address.attention
            - contract__cancelled_by_counterpart
            - bi_tenants_contract__previous_address.street_number
            - generalerrand_reporter__birth_date
            - subtenant__ssn
            - contract__id_number
            - tenant_signable_party__previous_address.street
            - contract__is_definitive_end_contract
            - subtenant__is_company
            - inspectionerrand_tenants__is_company
            - inspectionerrand__space.landlord_custom_id
            - parkingspot__address.street
            - parkingspot__address.city
            - inspectionerrand_tenants__future_address.care_of
            - tenant_signable_party__org_no
            - inspectionerrand_performers__custom_id
            - tenant_signable_party__previous_address.postal_code
            - inspectionerrand_tenants__phone_number
            - tenant_signable_party__future_address.street_number
            - bi_tenants_contract__previous_address.get_verbose_value
            - community__name
            - generalerrand_reporter__application_access_url
            - industrialpremises__custom_id
            - inspectionerrand_performers__email
            - outdoorsection__address.city
            - bi_tenants_contract__first_name
            - apartment__terms.warm_water_supply
            - sub_tenant_signable_party
            - generalerrand_organization_user_performers__profile_picture
            - sub_tenant_signable_party__application_access_user_segments
            - external_party__future_address.city
            - organization_user_party__org_no
            - notification_recipient__email
            - bi_tenants_contract__future_address.care_of
            - bi_tenants_contract__previous_address.care_of
            - external_party__email
            - external_party__popular_name
            - inspectionerrand_tenants__current_registered_address.care_of
            - generalerrand__custom_id
            - generalerrand__planned_done_time
            - inspectionerrand_tenants__previous_address.street_number
            - subtenant__current_registered_address.street
            - contract__last_counterpart_notification_date
            - generalerrand_organization_user_performers
            - inspectionerrand_performers
            - tenant_signable_party__current_registered_address.street
            - generalerrand_organization_user_performers__ssn
            - sub_tenant_signable_party__previous_address.postal_code
            - tenant__current_registered_address.street_number
            - subtenant__profile_picture
            - contract__cancellation_signed_time
            - tenant_signable_party__email
            - tenant__previous_address.country
            - bi_tenants_contract__birth_date
            - tenant__previous_address.city
            - subtenant__previous_address.postal_code
            - inspectionerrand_tenants__current_registered_address.postal_code
            - subtenant__previous_address.care_of
            - apartment__address.country
            - inspectionerrand_tenants__previous_address.care_of
            - external_party__future_address.care_of
            - external_party__previous_address.care_of
            - sub_tenant_signable_party__future_address.street_number
            - generalerrand_reporter
            - outdoorsection__bi_area
            - apartment__calculated_total_area
            - external_party__future_address.postal_code
            - notification_recipient__full_name
            - organization_user_party__full_name
            - inspectionerrand_tenants__full_name
            - industrialpremises__terms.additional_notations
            - inspectionerrand_performers__last_name
            - external_party__corporate_name
            - bi_tenants_contract__corporate_name
            - generalerrand_reporter__custom_id
            - subtenant__previous_address.attention
            - company_custom__bg_no
            - company_custom__prioritized_city
            - inspectionerrand_tenants__application_access_url
            - tenant_signable_party__previous_address.city
            - sub_tenant_signable_party__previous_address.get_verbose_value
            - industrialpremises__calculated_total_area
            - parkingspot__address.postal_code
            - generalerrand__verbose_status
            - bi_tenants_contract__custom_id
            - inspectionerrand
            - tenant__last_name
            - inspectionerrand_tenants__corporate_name
            - notification_recipient__communication_name
            - subtenant__corporate_name
            - contract__lifetime_end_date
            - notification__notification_url
            - apartment
            - external_party__future_address.country
            - tenant_signable_party__application_access_user_segments
            - notification_recipient__application_access_user_segments
            - tenant__previous_address.street_number
            - inspectionerrand_tenants__profile_picture
            - bi_tenants_contract__profile_picture
            - external_party__current_registered_address.care_of
            - sub_tenant_signable_party__profile_picture
            - external_party__future_address.street
            - sub_tenant_signable_party__current_registered_address.street
            - tenant__phone_number
            - bi_tenants_contract__org_no
            - tenant_signable_party__profile_picture
            - industrialpremises__address.city
            - inspectionerrand_tenants__current_registered_address.street_number
            - sub_tenant_signable_party__birth_date
            - industrialpremises__landlord_custom_id
            - tenant__previous_address.postal_code
            - external_party__application_access_user_segments
            - inspectionerrand_tenants__previous_address.street
            - invoice__total_value
            - generalerrand_reporter__org_no
            - tenant_signable_party__ssn
            - sub_tenant_signable_party__previous_address.street_number
            - inspectionerrand_performers__org_no
            - inspectionerrand_tenants__current_registered_address.attention
            - generalerrand_organization_user_performers__birth_date
            - inspectionerrand_performers__application_access_url
            - tenant__future_address.postal_code
            - generalerrand_organization_user_performers__first_name
            - contract__custom_id
            - tenant__birth_date
            - bi_tenants_contract__email
            - tenant_signable_party__current_registered_address.country
            - company_custom__prioritized_postal_code
            - inspectionerrand__custom_id
            - contract__initial_end_date
            - tenant_signable_party__current_registered_address.attention
            - generalerrand__address.street_number
            - subtenant__application_access_url
            - sub_tenant_signable_party__is_company
            - generalerrand_reporter__first_name
            - bi_tenants_contract__popular_name
            - bi_tenants_contract__previous_address.postal_code
            - invoice__ocr_number
            - invoice_custom
            - bi_tenants_contract__current_registered_address.get_verbose_value
            - organization_user_party__corporate_name
            - organization_user_party__phone_number
            - generalerrand
            - invoice__marking
            - sub_tenant_signable_party__future_address.country
            - generalerrand__title
            - organization_user_party__application_access_user_segments
            - industrialpremises__address.postal_code
            - sub_tenant_signable_party__previous_address.care_of
            - subtenant__future_address.care_of
            - contract__last_owner_notification_date
            - generalerrand_reporter__phone_number
            - sub_tenant_signable_party__full_name
            - inspectionerrand__space.address.city
            - generalerrand_organization_user_performers__application_access_url
            - inspectionerrand_tenants__custom_id
            - inspectionerrand_tenants__future_address.street
            - parkingspot__terms.additional_notations
            - inspectionerrand__setting.name
            - tenant_signable_party__last_name
            - contract__owner_notification_interval_weeks
            - generalerrand_reporter__last_name
            - external_party__birth_date
            - generalerrand_reporter__corporate_name
            - sub_tenant_signable_party__current_registered_address.postal_code
            - bi_tenants_contract__phone_number
            - notification_recipient__last_name
            - space_custom
            - notification
            - invoice__your_reference
            - external_party__previous_address.street_number
            - invoicerelatedpdffile__meta_total_value
            - external_party__current_registered_address.attention
            - notification_recipient__corporate_name
            - tenant_signable_party__full_name
            - generalerrand__actual_done_time
            - external_party__sni_number
            - sub_tenant_signable_party__email
            - tenant_signable_party__previous_address.street_number
            - tenant__current_registered_address.postal_code
            - apartment__bi_area
            - parkingspot__address.care_of
            - company__name
            - apartment__address.street
            - inspectionerrand__protocol_file
            - generalerrand_organization_user_performers__org_no
            - sub_tenant_signable_party__current_registered_address.attention
            - subtenant__custom_id
            - notification_recipient
            - industrialpremises__address.care_of
            - >-
              generalerrand_organization_user_performers__application_access_user_segments
            - subtenant__previous_address.city
            - apartment__address.get_verbose_value
            - inspectionerrand__space.address.country
            - industrialpremises
            - contract__renew_indefinetely
            - sub_tenant_signable_party__current_registered_address.city
            - inspectionerrand_tenants__current_registered_address.country
            - inspectionerrand_tenants__previous_address.postal_code
            - sub_tenant_signable_party__popular_name
            - outdoorsection__address.attention
            - inspectionerrand_tenants__previous_address.attention
            - apartment__terms.electricity_supply
            - generalerrand_organization_user_performers__last_name
            - apartment__address.care_of
            - tenant__org_no
            - apartment__apartment_id
            - generalerrand_reporter__ssn
            - basecontract_custom__monthly_rent
            - indoor_space_custom
            - tenant__current_registered_address.street
            - sub_tenant_signable_party__future_address.street
            - external_party__previous_address.country
            - invoice__attachment
            - inspectionerrand__actual_done_time
            - tenant__future_address.city
            - tenant__current_registered_address.country
            - generalerrand_reporter__profile_picture
            - bi_tenants_contract__sni_number
            - invoice__invoice_date
            - inspectionerrand_performers__application_access_user_segments
            - subtenant__future_address.street
            - subtenant__future_address.street_number
            - apartment__usable_area
            - bi_tenants_contract__previous_address.city
            - tenant__communication_name
            - sub_tenant_signable_party__first_name
            - >-
              inspectionerrand_tenants__current_registered_address.get_verbose_value
            - subtenant
            - inspectionerrand_tenants__popular_name
            - tenant_signable_party__communication_name
            - generalerrand_reporter__full_name
            - industrialpremises__bi_area
            - subtenant__future_address.city
            - tenant_signable_party__current_registered_address.care_of
            - bi_tenants_contract__future_address.street
            - external_party__future_address.street_number
            - subtenant__future_address.attention
            - parkingspot__custom_id
            - inspectionerrand__title
            - bi_tenants_contract__future_address.country
            - notification_recipient__first_name
            - tenant__email
            - anonymousgeneralerrandlink__link_url
            - external_party__last_name
            - tenant__custom_id
            - parkingspot__usable_area
            - subtenant__sni_number
            - bi_tenants_contract__current_registered_address.postal_code
            - company_custom__prioritized_street_and_number
            - industrialpremises__usable_area
            - invoice__total_vat_base_value
            - contract
            - industrialpremises__address.street_number
            - parkingspot__calculated_total_area
            - inspectionerrand__space.address.postal_code
            - outdoorsection__calculated_total_area
            - bi_tenants_contract__previous_address.country
            - outdoorsection__custom_id
            - company
            - bi_tenants_contract__communication_name
            - external_party__previous_address.postal_code
            - tenant__future_address.street
            - bi_tenants_contract__application_access_url
            - inspectionerrand__space.popular_name
            - sub_tenant_signable_party__previous_address.street
            - organization_user_party__custom_id
            - notification_recipient__birth_date
            - outdoorsection__address.postal_code
            - tenant__corporate_name
            - organization_user_party__profile_picture
            - tenant_signable_party__first_name
            - subtenant__last_name
            - tenant__first_name
            - inspectionerrand_performers__corporate_name
            - sub_tenant_signable_party__previous_address.city
            - inspectionerrand_tenants__org_no
            - subtenant__current_registered_address.postal_code
            - tenant_signable_party__future_address.care_of
            - generalerrand_organization_user_performers__full_name
            - organization_user_party__ssn
            - sub_tenant_signable_party__future_address.city
            - signable_document_attachments
            - inspectionerrand__space.address.street
            - generalerrand_organization_user_performers__communication_name
            - apartment__custom_id
            - outdoorsection__address.care_of
            - signable_document_attachments__attachments
            - notification_recipient__phone_number
            - tenant_signable_party__sni_number
            - generalerrand_organization_user_performers__email
            - bi_tenants_contract__previous_address.attention
            - bi_tenants_contract__current_registered_address.country
            - industrialpremises__address.country
            - subtenant__current_registered_address.get_verbose_value
            - signatory_field__regular_pen_signature
            - tenant_signable_party__birth_date
            - external_party
            - parkingspot__address.country
            - external_party__custom_id
            - subtenant__previous_address.street_number
            - tenant__application_access_url
            - contract__pending_re_negotiations
            - company_custom__prioritized_address
            - signatory_field
            - bi_tenants_contract__full_name
            - inspectionerrand_tenants__communication_name
            - outdoorsection__terms.additional_notations
            - tenant__profile_picture
            - inspectionerrand_tenants__sni_number
            - tenant_signable_party__corporate_name
            - organization_user_party__email
            - tenant_signable_party__previous_address.get_verbose_value
            - generalerrand__address.postal_code
            - invoice
            - subtenant__current_registered_address.city
            - inspectionerrand__spent_minutes
            - tenant_signable_party__application_access_url
            - external_party__is_company
            - subtenant__full_name
            - contract__cancellation_time
            - inspectionerrand_tenants__email
            - generalerrand_organization_user_performers__phone_number
            - subtenant__birth_date
            - outdoorsection__address.get_verbose_value
            - outdoorsection
            - generalerrand_organization_user_performers__corporate_name
            - tenant_signable_party__custom_id
            - external_party__phone_number
            - subtenant__application_access_user_segments
            - generalerrand_reporter__email
            - apartment__terms.additional_notations
            - >-
              sub_tenant_signable_party__current_registered_address.get_verbose_value
            - invoicerelatedpdffile
            - sub_tenant_signable_party__previous_address.country
            - tenant_signable_party__current_registered_address.postal_code
            - company__visiting_address.get_verbose_value
            - tenant__ssn
            - industrialpremises__address.get_full_street_value
            - apartment__tempered_area
          nullable: true
        ask_for_input:
          type: boolean
          nullable: false
        page_number:
          type: integer
          format: int32
          maximum: 2147483647
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value requires that the following fields are also set:
            `position_x_rel`
        created_at:
          type: string
          format: date-time
          nullable: false
          readOnly: true
        width_rel:
          type: number
          format: float
          maximum: 1
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value requires that the following fields are also set:
            `position_x_rel`
        id:
          type: string
          format: uuid
          nullable: false
          readOnly: true
          description: |-
            **Additional Validation Information:**

            Must be unique
        name:
          type: string
          maxLength: 255
          nullable: false
        allow_reverse_autofill_on_completion:
          type: boolean
          nullable: false
        party:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: false
          title: Signabledocumentparty
        height_rel:
          type: number
          format: float
          maximum: 1
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value requires that the following fields are also set:
            `position_x_rel`
        manual_forced_value:
          type: string
          nullable: true
        custom_id:
          type: string
          maxLength: 128
          nullable: true
        position_x_rel:
          type: number
          format: float
          maximum: 1
          nullable: true
          description: >-
            **Additional Validation Information:**


            This value must be set together with the following fields:
            `position_y_rel`, `font_size_rel`
      type: object
      required:
        - id
        - name
        - party
      description: 'Content Type: `documents.signabledocumentpartyfield`'
    documents.fileaccessshare:
      properties:
        id:
          type: string
          format: uuid
          nullable: false
          readOnly: true
          description: |-
            **Additional Validation Information:**

            Must be unique
        organization:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Organization
        custom_id:
          type: string
          maxLength: 128
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: false
          readOnly: true
      type: object
      required:
        - id
      description: 'Content Type: `documents.fileaccessshare`'
    documents.publicfile:
      properties:
        custom_id:
          type: string
          maxLength: 128
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: false
          readOnly: true
        content:
          type: object
          properties:
            name:
              type: string
              description: wanted filename of the file
            md5_hash:
              type: string
              description: base64 encoded md5hash of the file
            get:
              type: string
              format: url
            post:
              type: object
              properties:
                url:
                  type: string
                  format: url
                fields:
                  type: object
                  additionalProperties: true
          nullable: false
        id:
          type: string
          format: uuid
          nullable: false
          readOnly: true
          description: |-
            **Additional Validation Information:**

            Must be unique
        organization:
          type: object
          properties:
            id:
              type: string
              format: uuid
          nullable: true
          title: Organization
      type: object
      required:
        - content
        - id
      description: 'Content Type: `documents.publicfile`'
x-tagGroups:
  - name: Filehandling
    tags:
      - Fileaccessshare
      - Organizationuserfileaccessshare
      - Folder
      - Publicfile
  - name: Signing
    tags:
      - Signabledocumentpartyfield
      - Signabledocument
      - Signabledocumentparty
info:
  title: Documents
  version: 2.0.0
  description: The 'Documents' application of the Core API
