API Reference

v2024-05-20

March 25th,2025

Added

  • Added new endpoint GET /tenants/{tenantId}/reports/{reportId}/export to fetch a report with additional models like steps, process steps, interactions, and interaction values
  • Added new properties cycleTime and firstOpendAt to all endpoints returning a report object
  • Added new property parentConditionMatches to the response of GET /tenants/{tenantId}/reports/{reportId}/interaction-values and GET /tenants/{tenantId}/reports/{reportId}/interaction-values/interaction-version-persistent-id
  • Added new property type to response of GET /tenants/{tenantId}/documents/{documentId}/steps
  • Added new property localMaterialId to response of GET /tenants/{tenantId}/interactions/{interactionId} for material interactions
  • Added new property failIfSelected and failIfNotSelected to response of GET /tenants/{tenantId}/interactions/{interactionId} for choices in multiple-choice interactions

Fix

  • Return proper error message DOCUMENT_NOT_PUBLISHED for POST /tenants/{tenantId}/reports endpoint when trying to start a report for a not published document.
  • Return proper error message BLOCKED_ATTACHING_ARCHIVED_SUB_DOCUMENT for PUT /tenants/{tenantId}/documents/{documentId}/documents/{subDocumentId} endpoint when trying to attach archived sub-document with useLatestDocument set to true

March 13th,2025

Fix

  • Return proper error message for PATCH /tenants/{tenantId}/reports/{reportId} endpoint when updating the report, where the report is part of an order and the execution mode is sequence

March 10th,2025

Added

  • Added new endpoint GET /tenants/{tenantId}/reports/csv to fetch report data in csv format
  • Added new endpoint GET /tenants/{tenantId}/reports/xlsx to fetch report data as a XLSX file
  • Added new endpoint GET /tenants/{tenantId}/documents/{documentId}/steps to fetch all the steps of documents and their nested documents
  • Added tamil ta to the document language

February 24th,2025

Added

  • Added new properties in the payload for pdf report generation job POST /tenants/{tenantId}/reports/{reportId}/pdfs to support customizing the pdf generation

February 10th,2025

Deprecated

Old pdf generation endpoints POST /tenants/{tenantId}/reports/{reportId}/generate-pdf, GET /tenants/{tenantId}/report-pdfs/{reportPdfId} and GET /tenants/{tenantId}/report-pdfs/{reportPdfId}/file.pdf are deprecated and will be removed in the next api version in favor of new one GET /tenants/{tenantId}/pdf-jobs/{pdfJobId}, GET /tenants/{tenantId}/pdf-jobs/{pdfJobId}/file and POST /tenants/{tenantId}/reports/{reportId}/pdfs

Added

  • Added new endpoint GET /tenants/{tenantId}/pdf-jobs/{pdfJobId} to fetch report pdf generation job
  • Added new endpoint GET /tenants/{tenantId}/pdf-jobs/{pdfJobId}/file to fetch generated report pdf

January 30th,2025

Added

  • Added new property numFinishedSteps to the response of GET /tenants/{tenantId}/reports, GET /tenants/{tenantId}/reports/{reportId}, PATCH /tenants/{tenantId}/reports/{reportId}, POST /tenants/{tenantId}/reports and POST /tenants/{tenantId}/orders/{orderId}/reports/detach endpoints
  • Added new endpoint POST /tenants/{tenantId}/reports/{reportId}/pdfs to create pdf report generation job

Fix

  • Fix validation for PATCH /tenants/{tenantId}/orders/{orderId} sending state scheduled is not a valid value

December 16th, 2024

Fix

  • Return interaction values for archived reports when calling GET /tenants/{tenantId}/reports/{reportId}/interaction-values endpoint

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

September 23th, 2024

Added

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

September 9th, 2024

Added

  • 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

August 12th, 2024

Fix

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

July 15th, 2024

Added

  • 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

Fix

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

July 1st, 2024

Added

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

June 3rd, 2024

Added

  • 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

Fix

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

May 20th, 2024

Release

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.

Changed

  • 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

  • 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