October 7th, 2024

Added

Added new possibility to create steps, process steps and some interactions when creating a new document via POST /tenants/{tenantId}/documents endpoint

Added new endpoint PUT /tenants/{tenantId}/documents/{documentId}/documents/{subDocumentId} to add sub-document to a document

Added new endpoint GET /tenants/{tenantId}/global-materials to fetch a list of global materials
Added new endpoint PATCH /tenants/{tenantId}/global-materials/{globalMaterialId} to update global material
Added new endpoint DELETE /tenants/{tenantId}/global-materials/{globalMaterialId}/class-characteristics/{classCharacteristicId} to delete class characteristic from global material
Added new endpoint PUT /tenants/{tenantId}/global-materials/{globalMaterialId}/class-characteristics/{classCharacteristicId} to add class characteristic to global material
Added new endpoint POST /tenants/{tenantId}/orders/{orderId}/pdfs to attach pdf to order

Return proper error message for POST /tenants/{tenantId}/reports/{reportId}/generate-pdf endpoint for invalid reportId

Added new endpoint POST /tenants/{tenantId}/reports/{reportId}/share-links to create a share link for a report
Add possibility to update visible property for a document in PATCH /tenants/{tenantId}/documents/{documentId} endpoint

Return proper error message for PATCH /tenants/{tenantId}/documents/{documentId} endpoint when trying to set hasVariables to true for a visible document

Added new endpoint PUT /tenants/{tenantId}/global-materials/{globalMaterialId}/image to update the image of the global material

Added new endpoint PUT /tenants/{tenantId}/documents/{documentId}/qr-codes/{qrCodeId} to add QR code to the document
Added new endpoint POST /tenants/{tenantId}/orders/{orderId}/duplicate to create a duplicate order
Added new endpoint POST /tenants/{tenantId}/orders/{orderId}/instantiate to instantiate an order
Added new endpoint POST /tenants/{tenantId}/global-materials to create global material

Return proper error message for POST /tenants/{tenantId}/orders endpoint when the provided document id is not published

New public api version 2024-05-20 is released. Previous version 2023-09-18 is now deprecated, please set accept-version header to 2024-05-20.

Response property states renamed to state for endpoint GET /tenants/{tenantId}/orders
Response property states renamed to state for endpoint PATCH /tenants/{tenantId}/orders/{orderId}
Response property states renamed to state for endpoint POST /tenants/{tenantId}/orders
Response property comments renamed to additionalData for endpoint GET /tenants/{tenantId}/orders
Response and request property comments renamed to additionalData for endpoint PATCH /tenants/{tenantId}/orders/{orderId}
Response and request property comments renamed to additionalData for endpoint POST /tenants/{tenantId}/orders
If unsupported accept-version header public-api version is used, fallback to latest version.
Request property classCharacteristicsIds renamed to classCharacteristicIds for endpoint POST /tenants/{tenantId}/orders
Request property classCharacteristicsIds renamed to classCharacteristicIds for endpoint POST /tenants/{tenantId}/orders/{orderId}/order-document-assignments
Response property comments renamed to comment for endpoints GET /tenants/{tenantId}/reports, GET /tenants/{tenantId}/reports/{reportId},
PATCH /tenants/{tenantId}/reports/{reportId} and POST /tenants/{tenantId}/reports
Property pdfs removed from endpoint GET /tenants/{tenantId}/reports

Added new endpoint GET /tenants/{tenantId}/documents/{documentId}/step-tree to fetch all the steps attached to the document
Added new endpoint PATCH /tenants/{tenantId}/documents/{documentId} to update document
Added new endpoint POST /tenants/{tenantId}/documents/{documentId}/duplicate for creating duplicate document
Added new endpoint PUT /tenants/{tenantId}/documents/{documentId}/class-characteristics/:classCharacteristicId to attach class characteristic to the document
Added new endpoint DELETE /tenants/{tenantId}/documents/{documentId}/class-characteristics/:classCharacteristicId to detach class characteristic from the document
Added new endpoint POST /tenants/{tenantId}/documents/{documentId}/versioning to update the versioning state of the document
Added new endpoint PATCH /tenants/{tenantId}/tasks/{taskId} to update the task
Added new endpoint PUT /tenants/{tenantId}/orders/{orderId}/class-characteristics to replace class characteristics from the order
Added new endpoint DELETE /tenants/{tenantId}/documents/{documentId}/documents/:subDocumentId to delete sub-document
Added new endpoint POST /tenants/{tenantId}/tasks/{taskId}/message to create a message in the task
Extend GET /tenants/{tenantId}/orders endpoint to fetch orders filtered by classCharacteristicIds
Added new endpoint POST /tenants/{tenantId}/qr-codes to create qr-code