API Reference

v2025-04-21

August 11th, 2025

Fix

  • No longer throw a 500 error when duplicated class characteristic ids are sent to PUT /tenants/{tenantId}/orders/{orderId}/class-characteristics endpoint.

July 14th, 2025

Added

  • Added showOrderInformation query option for GET /tenants/{tenantId}/reports/{reportId}/pdfs endpoint to include order information in PDF.

June 30th, 2025

Fix

  • Return proper unit property in the response payload of the GET /tenants/{tenantId}/reports/{reportId}/export endpoint for number interactions. Before it was always null.
  • Return 409 Conflict error when trying to attach a document with variables to a document without variables via the PUT /tenants/{tenantId}/documents/{documentId}/documents/{subDocumentId} endpoint.

Added

  • Added qualifications properties to the response payload of the GET /tenants/{tenantId}/users/{userId} endpoint.
  • Added qualificationIds request payload for POST /tenants/{tenantId}/users endpoint to create user with assigned qualifications.
  • Added new endpoint GET /tenants/{tenantId}/qualifications to get qualifications list
  • Added new endpoint DELETE /tenants/{tenantId}/qualification/{qualificationId} to delete user qualification

June 16th, 2025

Added

  • Added new endpoint POST /tenants/{tenantId}/users/{userId}/qualifications to upsert user qualifications
  • Added classCharacteristics and orderPosition properties to the response payload of the GET /tenants/{tenantId}/reports endpoint.
  • Added query parameters classCharacteristicIds and orderIds to the GET /tenants/{tenantId}/reports endpoint to filter reports by class characteristics or order ids

June 2nd, 2025

Added

  • Added possibility to update executionMode via PATCH /tenants/{tenantId}/orders/{orderId} endpoint
  • Added new property orderPosition to the response payload of the GET /tenants/{tenantId}/reports/{reportId} endpoint to indicate the position of the report within an order

May 5th, 2025

Added

  • Added new endpoint POST /tenants/{tenantId}/documents/translations to upload translations
  • Added new endpoint POST /tenants/{tenantId}/documents/{documentId}/qualifications-required to add required qualification to document
  • Added new endpoint POST /tenants/{tenantId}/documents/{documentId}/qualifications-granted to add granted qualification to document

April 23rd, 2025

Fix

  • Fixed the problem that for endpoint POST /tenants/{tenantId}/orders/ the value of useLatestDocument was ignored and instead the default value true was always used

Changed

  • Endpoints POST /tenants/{tenantId}/documents, PATCH /tenants/{tenantId}/documents/{documentId}, GET /tenants/{tenantId}/documents/{documentId} now includes granted and required qualifications
  • Endpoint POST /tenants/{tenantId}/documents now supports document creation with granted and required qualifications.

April 21st, 2025

Release

New public api version 2025-04-21 is released. Previous version 2024-05-20 is now deprecated, please set accept-version header to 2025-04-21.

Changed

  • Property assigneeId has been removed from request payload for the POST /tenants/{tenantId}/tasks and PATCH /tenants/{tenantId}/tasks/{taskId} endpoints

  • Properties assigneeId and assigneeUserName have been removed from response payload for the GET /tenants/{tenantId}/tasks, POST /tenants/{tenantId}/tasks, and PATCH /tenants/{tenantId}/tasks/{taskId} endpoints

  • Properties classFilterAssistant and classFilterEditor have been removed from request payload for the POST /tenants/{tenantId}/users and PATCH /tenants/{tenantId}/users/:userId endpoints

  • Renamed endpoint GET /tenants/{tenantId}/images-feedback/{imageFeedbackId}/file to GET /tenants/{tenantId}/image-feedbacks/{imageFeedbackId}/file

  • Renamed endpoint GET /tenants/{tenantId}/videos-feedback/{videoFeedbackId}/file to GET /tenants/{tenantId}/video-feedbacks/{videoFeedbackId}/file

  • Endpoint GET /tenants/{tenantId}/pdfs-feedback/{pdfFeedbackId}/file.pdf was renamed to GET /tenants/{tenantId}/pdf-feedbacks/{pdfFeedbackId}/file to be consistent with other endpoints.

  • The following search query parameters now require at least 3 characters:

    • Query parameter name for endpoint GET /tenenats/{tenantId}/roles
    • Query parameter search for endpoint GET /tenants/{tenantId}/orders
    • Query parameters search, customId and location for endpoint GET /tenants/{tenantId}/global-materials

  • Property assignedUserIds and assignedGroupIds was added, assigneeId was removed from the request payload PATCH /tenants/{tenantId}/orders/{orderId}

  • Property assignedUsers and assignedGroups was added, assigneeId and assigneeUserName was removed from the response payload PATCH /tenants/{tenantId}/orders/{orderId}

  • Property assignedUsers and assignedGroups was added to the response payload GET /tenants/{tenantId}/orders

  • Property assignedUserIds and assignedGroupIds was added, assigneeId was removed from the request payload POST /tenants/{tenantId}/orders

Added

  • Added new endpoint GET /tenants/{tenantId}/documents/{documentId}/export to fetch a document with additional data like steps, process steps, interactions, and interaction choices

  • Added new properties assignedUserIds and assignedGroupsIds to the request payload for the POST /tenants/{tenantId}/tasks and PATCH /tenants/{tenantId}/tasks/{taskId} endpoints for assigning and updating multiple users or groups related to the task

  • Added new properties assignedUsers and assignedGroups to the response payload for the
    GET /tenants/{tenantId}/tasks, POST /tenants/{tenantId}/tasks, and PATCH /tenants/{tenantId}/tasks/{taskId} endpoints

  • Added new property classFilter to the request payload for the POST /tenants/{tenantId}/users and PATCH /tenants/{tenantId}/users/:userId endpoints for assigning and updating saved classifier filters for users

Removed

  • Removed endpoint POST /tenants/{tenantId}/reports/{reportId}/generate-pdf, GET /tenants/{tenantId}/report-pdfs/{reportPdfId} and GET /tenants/{tenantId}/report-pdfs/{reportPdfId}/file.pdf.
    Use the new PDF generation endpoints POST /tenants/{tenantId}/reports/{reportId}/pdfs, GET /tenants/{tenantId}/pdf-jobs/{pdfJobId} and GET /tenants/{tenantId}/pdf-jobs/{pdfJobId}/file instead.

  • Removed property pdfs from the response of the following endpoints:

    • POST /tenants/{tenantId}/orders/{orderId}/reports/detach
    • GET /tenants/{tenantId}/reports/{reportId}
    • PATCH /tenants/{tenantId}/reports/{reportId}