openapi: 3.0.2
info:
  version: '28'
  title: Kiteworks API Documentation activities dli API
tags:
- name: dli
paths:
  /rest/dli/exports:
    get:
      tags:
      - dli
      summary: Return the list of all exports for all users
      description: Returns a paginated list of all data exports across all users, including each export's status, type, date range, and download URL. Requires admin privileges.
      responses:
        '200':
          description: List of exports retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Export'
                  metadata:
                    $ref: '#/components/schemas/MetaData'
              examples:
                ExportList:
                  summary: Paginated list of exports
                  value:
                    data:
                    - id: exp-guid-001
                      status: completed
                      type: files
                      startDate: '2024-01-01'
                      endDate: '2024-01-31'
                      userId: u1a2b3c4-d5e6-7890-abcd-ef1234567890
                      generatedDate: '2024-02-01T08:00:00Z'
                      fileName: export_files_jan2024.zip
                      downloadURL: https://example.com/exports/exp-guid-001
                    metadata:
                      total: 1
                      limit: 50
                      offset: 0
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: query
        name: user_id
        description: Unique identifier of user
        schema:
          type: string
      - in: query
        name: user_id:in
        description: Unique identifier of user. Search for results that match any of the specified values for this parameter.
        schema:
          type: string
      - in: query
        name: status
        description: Status of the generated report
        schema:
          type: string
      - in: query
        name: status:contains
        description: Status of the generated report. Search for results that contain the specified characters in this parameter.
        schema:
          type: string
      - in: query
        name: offset
        description: Offset
        schema:
          type: integer
      - in: query
        name: limit
        description: Limit
        schema:
          type: integer
      - in: query
        name: with
        description: With parameters
        schema:
          type: string
      - in: query
        name: mode
        description: Determines the detail level of the response body.
        schema:
          type: string
          enum:
          - full_with_links
          - full
          - compact
  /rest/dli/exports/users/{id}:
    post:
      tags:
      - dli
      summary: Start generating export for the specified user
      description: Initiates one or more data export jobs for the specified user based on the requested report types and date range. Returns the newly created export record(s) in a pending state. Requires admin privileges.
      responses:
        '200':
          description: Export job(s) created successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Export'
                  metadata:
                    $ref: '#/components/schemas/MetaData'
              examples:
                ExportCreated:
                  summary: Newly created export in pending state
                  value:
                    data:
                    - id: exp-guid-002
                      status: pending
                      type: activities
                      startDate: '2024-03-01'
                      endDate: '2024-03-31'
                      userId: u1a2b3c4-d5e6-7890-abcd-ef1234567890
                      generatedDate: null
                      fileName: null
                      downloadURL: null
                    metadata:
                      total: 1
                      limit: 50
                      offset: 0
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI, ERR_ACCESS_USER'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
                ERR_ACCESS_USER:
                  summary: Insufficient access permissions
                  description: Insufficient access permissions
                  value:
                    errors:
                      code: ERR_ACCESS_USER
                      message: Insufficient access permissions
        '422':
          description: 'Unprocessable Content<br /><br /><i>Possible error codes: </i>ERR_INPUT_INVALID_DATE, ERR_INPUT_DATE_NOT_BEFORE, ERR_INPUT_REQUIRED, ERR_INPUT_DATE_NOT_AFTER, ERR_INPUT_NOT_ARRAY, ERR_INPUT_NOT_IN_LIST'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_INPUT_REQUIRED:
                  summary: Field is required
                  description: Field is required
                  value:
                    errors:
                      code: ERR_INPUT_REQUIRED
                      message: Field is required
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: path
        name: id
        description: ID of the user
        required: true
        schema:
          type: string
      - in: query
        name: returnEntity
        description: If set to `true`, returns information about the newly created entity.
        schema:
          type: boolean
      - in: query
        name: mode
        description: Determines the detail level of the response body.
        schema:
          type: string
          enum:
          - full_with_links
          - full
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Export.Post'
  /rest/dli/exports/{id}:
    get:
      tags:
      - dli
      summary: Return information of an export such as status, download url, user ID, etc.
      description: Returns the details of a specific export job, including its status, type, date range, the user it belongs to, and the download URL when the export is complete. Requires admin privileges.
      responses:
        '200':
          description: Export details retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Export'
                  metadata:
                    $ref: '#/components/schemas/MetaData'
              examples:
                ExportCompleted:
                  summary: A completed export with a download URL
                  value:
                    id: exp-guid-001
                    status: completed
                    type: files
                    startDate: '2024-01-01'
                    endDate: '2024-01-31'
                    userId: u1a2b3c4-d5e6-7890-abcd-ef1234567890
                    generatedDate: '2024-02-01T08:00:00Z'
                    fileName: export_files_jan2024.zip
                    downloadURL: https://example.com/exports/exp-guid-001
                ExportPending:
                  summary: An export still being generated
                  value:
                    id: exp-guid-002
                    status: pending
                    type: activities
                    startDate: '2024-03-01'
                    endDate: '2024-03-31'
                    userId: u1a2b3c4-d5e6-7890-abcd-ef1234567890
                    generatedDate: null
                    fileName: null
                    downloadURL: null
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI, ERR_ACCESS_USER'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
                ERR_ACCESS_USER:
                  summary: Insufficient access permissions
                  description: Insufficient access permissions
                  value:
                    errors:
                      code: ERR_ACCESS_USER
                      message: Insufficient access permissions
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: path
        name: id
        description: ID of the export
        required: true
        schema:
          type: integer
    delete:
      tags:
      - dli
      summary: Delete the specified export.
      description: Permanently deletes the specified export record and its associated data. Requires admin privileges.
      responses:
        '204':
          description: Export deleted successfully.
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI, ERR_ACCESS_USER'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
                ERR_ACCESS_USER:
                  summary: Insufficient access permissions
                  description: Insufficient access permissions
                  value:
                    errors:
                      code: ERR_ACCESS_USER
                      message: Insufficient access permissions
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: path
        name: id
        description: ID of the export
        required: true
        schema:
          type: integer
  /rest/dli/exports/{id}/content:
    get:
      tags:
      - dli
      summary: Download the generated export.
      description: Downloads the generated export file as a binary stream. The export must be in a completed state before it can be downloaded. Requires admin privileges.
      responses:
        '200':
          description: Export file returned as a binary stream.
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI, ERR_ACCESS_USER'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
                ERR_ACCESS_USER:
                  summary: Insufficient access permissions
                  description: Insufficient access permissions
                  value:
                    errors:
                      code: ERR_ACCESS_USER
                      message: Insufficient access permissions
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: path
        name: id
        description: ID of the export
        required: true
        schema:
          type: integer
  /rest/dli/files/{fileId}/users/{userId}/activities:
    get:
      tags:
      - dli
      summary: Return the list of Activities for this file
      description: Returns all activities performed by the specified user on the specified file. Each activity includes the affected object, a human-readable message, the acting user, and whether the action was successful. Requires admin privileges.
      responses:
        '200':
          description: List of file activities for the user retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ActivityAdmin'
              examples:
                FileActivities:
                  summary: Activities on a file by a user
                  value:
                    data:
                    - object:
                        id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                        name: contract.pdf
                        type: file
                      message: User downloaded file contract.pdf
                      directUser:
                        id: u1a2b3c4-d5e6-7890-abcd-ef1234567890
                        name: Alice Smith
                        email: alice@example.com
                      successful: 1
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI, ERR_ACCESS_USER'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
                ERR_ACCESS_USER:
                  summary: Insufficient access permissions
                  description: Insufficient access permissions
                  value:
                    errors:
                      code: ERR_ACCESS_USER
                      message: Insufficient access permissions
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: path
        name: fileId
        description: ID of the file
        required: true
        schema:
          type: string
      - in: path
        name: userId
        description: The unique identifier of the user.
        required: true
        schema:
          type: string
      - in: query
        name: noDayBack
        description: Number of days back to search
        schema:
          type: integer
      - in: query
        name: startDate
        description: Start date
        schema:
          type: string
          format: date
      - in: query
        name: endDate
        description: End date
        schema:
          type: string
          format: date
      - in: query
        name: filter
        description: 'Filter activities by scope. Accepted values: `all`, `my`.'
        schema:
          type: string
          enum:
          - all
          - my
      - in: query
        name: search
        description: Search by mail body, subject and sender/recipients
        schema:
          type: string
      - in: query
        name: type
        description: 'Filter activities by type. Accepted values: `all`, `folder_changes`, `file_changes`, `user_preferences`, `mail`, `tasks`, `comments`, `kitepoint`.'
        schema:
          type: string
          enum:
          - all
          - folder_changes
          - file_changes
          - user_preferences
          - mail
          - tasks
          - comments
          - kitepoint
      - in: query
        name: transactionId
        description: Transaction ID associated with the activities
        schema:
          type: string
      - in: query
        name: orderBy
        description: Sorting options
        schema:
          type: array
          items:
            type: string
          enum:
          - created:asc
          - created:desc
          - name:asc
          - name:desc
      - in: query
        name: offset
        description: Offset
        schema:
          type: integer
      - in: query
        name: limit
        description: Limit
        schema:
          type: integer
      - in: query
        name: with
        description: With parameters
        schema:
          type: string
      - in: query
        name: mode
        description: Determines the detail level of the response body.
        schema:
          type: string
          enum:
          - full_with_links
          - full
          - compact
  /rest/dli/files/{id}:
    get:
      tags:
      - dli
      summary: Retrieve information about the file specified.
      description: Returns metadata for the specified file, including its name, size, MIME type, content fingerprint, creation and modification dates, deletion status, and lock state.
      responses:
        '200':
          description: File metadata retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              examples:
                FileInfo:
                  summary: File metadata
                  value:
                    id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    name: contract.pdf
                    size: 204800
                    mime: application/pdf
                    fingerprint: d41d8cd98f00b204e9800998ecf8427e
                    created: '2024-01-15T10:30:00Z'
                    modified: '2024-03-20T14:45:00Z'
                    deleted: false
                    locked: 0
                    parentId: f0e1d2c3-b4a5-6789-0fed-cba987654321
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI, ERR_ACCESS_USER'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
                ERR_ACCESS_USER:
                  summary: Insufficient access permissions
                  description: Insufficient access permissions
                  value:
                    errors:
                      code: ERR_ACCESS_USER
                      message: Insufficient access permissions
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: path
        name: id
        description: ID of the file
        required: true
        schema:
          type: string
      - in: query
        name: with
        description: With parameters
        schema:
          type: string
      - in: query
        name: mode
        description: Determines the detail level of the response body.
        schema:
          type: string
          enum:
          - full_with_links
          - full
          - compact
  /rest/dli/files/{id}/content:
    get:
      tags:
      - dli
      summary: Read file content
      description: Downloads the binary content of the specified file. Supports partial downloads via the Range header.
      responses:
        '200':
          description: File content returned as a binary stream.
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI, ERR_ACCESS_USER'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
                ERR_ACCESS_USER:
                  summary: Insufficient access permissions
                  description: Insufficient access permissions
                  value:
                    errors:
                      code: ERR_ACCESS_USER
                      message: Insufficient access permissions
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: path
        name: id
        description: ID of the file
        required: true
        schema:
          type: string
      - in: header
        name: Range
        description: Range of bytes to download. e.g. `bytes=0-1024`
        schema:
          type: string
  /rest/dli/files/{id}/path:
    get:
      tags:
      - dli
      summary: Get file path
      description: Returns the full ancestor path of the specified file as an ordered list of folder nodes, from the workspace root down to the file's parent folder.
      responses:
        '200':
          description: File path retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilePathResponse'
              examples:
                FilePath:
                  summary: Path from workspace root to the file's parent folder
                  value:
                    data:
                    - id: root-folder-guid
                      name: Workspace
                    - id: sub-folder-guid
                      name: Projects
                    - id: parent-folder-guid
                      name: Q1 Reports
                    links:
                    - rel: self
                      href: https://example.com/api/rest/1/dli/files/a1b2c3d4/path
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI, ERR_ACCESS_USER'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
                ERR_ACCESS_USER:
                  summary: Insufficient access permissions
                  description: Insufficient access permissions
                  value:
                    errors:
                      code: ERR_ACCESS_USER
                      message: Insufficient access permissions
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: path
        name: id
        description: ID of the file
        required: true
        schema:
          type: string
      - in: query
        name: mode
        description: Determines the detail level of the response body.
        schema:
          type: string
          enum:
          - full_with_links
          - full
  /rest/dli/files/{id}/preview:
    get:
      tags:
      - dli
      summary: Retrieve information about the file preview.
      description: Returns preview access links and processing status for the specified file.
      responses:
        '200':
          description: Preview metadata retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Preview'
              examples:
                PreviewReady:
                  summary: Preview is available
                  value:
                    link: https://example.com/preview/abc123/dli/1
                    pdf: https://example.com/preview/abc123/pdf/dli/1
                    viewUrl: https://example.com/preview/abc123/view/dli/1
                    status: Preview
                    watermark: CONFIDENTIAL
                    tdfOriginalExtension: null
                PreviewProcessing:
                  summary: Preview is still being generated
                  value:
                    link: https://example.com/preview/abc123/dli/1
                    pdf: https://example.com/preview/abc123/pdf/dli/1
                    viewUrl: https://example.com/preview/abc123/view/dli/1
                    status: Processing
                    watermark: null
                    tdfOriginalExtension: null
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI, ERR_ACCESS_USER'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
                ERR_ACCESS_USER:
                  summary: Insufficient access permissions
                  description: Insufficient access permissions
                  value:
                    errors:
                      code: ERR_ACCESS_USER
                      message: Insufficient access permissions
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: path
        name: id
        description: ID of the file
        required: true
        schema:
          type: string
  /rest/dli/files/{id}/versions:
    get:
      tags:
      - dli
      summary: List versions
      description: Returns a paginated list of all versions for the specified file. Each version includes its name, size, MIME type, creation date, creator, and content fingerprint.
      responses:
        '200':
          description: List of file versions retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Version'
                  metadata:
                    $ref: '#/components/schemas/MetaData'
              examples:
                VersionList:
                  summary: Paginated list of versions
                  value:
                    data:
                    - id: v1b2c3d4-e5f6-7890-abcd-ef1234567890
                      name: report_v2.pdf
                      versionNumber: 2
                      size: 102400
                      mime: application/pdf
                      fingerprint: abc123def456
                      created: '2024-03-20T14:45:00Z'
                      deleted: false
                      objectId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    metadata:
                      total: 1
                      limit: 50
                      offset: 0
        '403':
          description: 'Forbidden<br /><br /><i>Possible error codes: </i>ERR_LICENSE_DLI, ERR_ACCESS_USER'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                ERR_LICENSE_DLI:
                  summary: Feature DLI is not enabled by license
                  description: Feature DLI is not enabled by license
                  value:
                    errors:
                      code: ERR_LICENSE_DLI
                      message: Feature DLI is not enabled by license
                ERR_ACCESS_USER:
                  summary: Insufficient access permissions
                  description: Insufficient access permissions
                  value:
                    errors:
                      code: ERR_ACCESS_USER
                      message: Insufficient access permissions
        '490':
          description: Request blocked by WAF
      deprecated: false
      parameters:
      - in: path
        name: id
        description: Object id of file to retrieve versions for
        required: true
        schema:
          type: string
      - in: query
        name: created
        description: File Version creation date
        schema:
          type: integer
      - in: query
        name: created:gt
        description: File Version creation date. Search for results where this parameter value is greater than the specified value.
        schema:
          type: integer
      - in: query
        name: created:gte
        description: File Version creation date. Search for results where this parameter value is greater than or equal to the specified value.
        schema:
          type: integer
      - in: query
        name: created:lt
        description: File Version creation date. Search for results where this parameter value is less than the specified value.
        schema:
          type: integer
      - in: query
        name: created:lte
        description: File Version creation date. Search for results where this parameter value is less than or equal to the specified value.
        schema:
          type: integer
      - in: query
        name: orderBy
        description: Sorting options
        schema:
          type: array
          items:
            type: string
          enum:
          - id:asc
          - id:desc
          - versionNumber:asc
          - versionNumber:desc
          - created:asc
          - created:desc
      - in: query
        name: offset
        description: Offset
        schema:
          type: integer
      - in: query
        name: limit
        description: Limit
        schema:
          type: integer
      - in: query
        name: locate_id
        description: "If specified, \"offset\" parameter will be ignored\n                                            and the page containing entity with this Id will be returned."
        schema:
          type: integer
      - in: query
        name: with
        description: With parameters
        schema:
          type: string
      - in: query
        name: mode
        description: Determines the detail level of the response body.
        schema:
          type: string
          enum:
          - full_with_links
          - full
          - compact
  /rest/dli/files/{id}/versions/{version_id}:
    get:
      tags:
      - dli
      summary: Allow DLI admin to get specified version
      description: Returns the metadata for a specific version of a file, including its name, size, MIME type, creation date, creator, and content fingerprint.
      responses:
        '200':
          description: Version metadata retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Version'
              examples:
                VersionInfo:
                  su

# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kiteworks/refs/heads/main/openapi/kiteworks-dli-api-openapi.yml