May 5th, 2025
Added
- Added new endpoint
POST /tenants/{tenantId}/documents/translations
to upload translations
April 23rd, 2025
Fix
- Fixed the problem that for endpoint
POST /tenants/{tenantId}/orders/
the value ofuseLatestDocument
was ignored and instead the default valuetrue
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 thePOST /tenants/{tenantId}/tasks
andPATCH /tenants/{tenantId}/tasks/{taskId}
endpoints -
Properties
assigneeId
andassigneeUserName
have been removed from response payload for theGET /tenants/{tenantId}/tasks
,POST /tenants/{tenantId}/tasks
, andPATCH /tenants/{tenantId}/tasks/{taskId}
endpoints -
Properties
classFilterAssistant
andclassFilterEditor
have been removed from request payload for thePOST /tenants/{tenantId}/users
andPATCH /tenants/{tenantId}/users/:userId
endpoints -
Renamed endpoint
GET /tenants/{tenantId}/images-feedback/{imageFeedbackId}/file
toGET /tenants/{tenantId}/image-feedbacks/{imageFeedbackId}/file
-
Renamed endpoint
GET /tenants/{tenantId}/videos-feedback/{videoFeedbackId}/file
toGET /tenants/{tenantId}/video-feedbacks/{videoFeedbackId}/file
-
Endpoint
GET /tenants/{tenantId}/pdfs-feedback/{pdfFeedbackId}/file.pdf
was renamed toGET /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 endpointGET /tenenats/{tenantId}/roles
- Query parameter
search
for endpointGET /tenants/{tenantId}/orders
- Query parameters
search
,customId
andlocation
for endpointGET /tenants/{tenantId}/global-materials
- Query parameter
-
Property
assignedUserIds
andassignedGroupIds
was added,assigneeId
was removed from the request payloadPATCH /tenants/{tenantId}/orders/{orderId}
-
Property
assignedUsers
andassignedGroups
was added,assigneeId
andassigneeUserName
was removed from the response payloadPATCH /tenants/{tenantId}/orders/{orderId}
-
Property
assignedUsers
andassignedGroups
was added to the response payloadGET /tenants/{tenantId}/orders
-
Property
assignedUserIds
andassignedGroupIds
was added,assigneeId
was removed from the request payloadPOST /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
andassignedGroupsIds
to the request payload for thePOST /tenants/{tenantId}/tasks
andPATCH /tenants/{tenantId}/tasks/{taskId}
endpoints for assigning and updating multiple users or groups related to the task -
Added new properties
assignedUsers
andassignedGroups
to the response payload for the
GET /tenants/{tenantId}/tasks
,POST /tenants/{tenantId}/tasks
, andPATCH /tenants/{tenantId}/tasks/{taskId}
endpoints -
Added new property
classFilter
to the request payload for thePOST /tenants/{tenantId}/users
andPATCH /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}
andGET /tenants/{tenantId}/report-pdfs/{reportPdfId}/file.pdf
.
Use the new PDF generation endpointsPOST /tenants/{tenantId}/reports/{reportId}/pdfs
,GET /tenants/{tenantId}/pdf-jobs/{pdfJobId}
andGET /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}