Many organizations depend on manual processes and spreadsheets to track or manage assessments and questionnaires, which can be time-consuming, resource-intensive, and error-prone. Collibra offers a solution to these challenges through the Collibra Assessments REST API. This API allows you to extract data from Assessments for data processing, reporting, trend analysis, making informed data governance decisions, or reintegrating the data into Collibra assets.
Capabilities
With the Collibra Assessments REST API, you can:
- Retrieve an assessment: To generate customized reports, start process automation, and notify the owner and assignees of the assessment.
- Start an assessment: To create a follow-up assessment based on an existing one, for example, DPIA periodic review.
- Upload attachments in assessments: To add images in rich text responses and upload files in file upload fields in assessments.
- Edit an assessment: To update assessment details, such as editing responses or properties. You can pre-fill questions in the assessment with information about the asset.
- Complete or submit an assessment: To finalize an assessment by marking it as complete or submitting it for review.
- Retake an assessment: To restart an assessment to address changes, for example, when the assessment is rejected.
- Import an assessment: To import an assessment from an external source into Collibra.
- Delete an assessment: To delete an assessment that is no longer needed to ensure your workspace remains organized.
Note You can also call the Assessments API within a workflow to retrieve or start an assessment from the workflow. For more information, go to Create or retrieve an assessment via workflows.
Limitations
When using the Collibra Assessments REST API to edit or submit assessments, certain restrictions and validations that are enforced in the Assessments user interface (UI) aren't applied.
- When editing an assessment, the API doesn't enforce the asset type and asset status constraints defined for an asset picker field in the template. Additionally, the API allows filling a field that is set to be hidden in the template.
- When submitting an assessment, the API doesn't enforce validation to ensure that all required fields in an assessment are filled.