> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/assessments-v2/models.md). # Models ## The CreateAssessmentRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"CreateAssessmentRequest":{"description":"A request object to start conducting an assessment. It should contain at least a `template` and a `name` or an `asset`. If you provide both a name and an asset, the asset's name stored in Collibra is used as the name of the assessment. When specified, the asset must have the same asset type used in the template. In addition, if the `owner` is not specified, the authenticated user is by default used as owner of the assessment.","type":"object","properties":{"template":{"$ref":"#/components/schemas/BaseTemplate"},"status":{"$ref":"#/components/schemas/AssessmentStatus"},"name":{"description":"The name of the assessment.","type":"string"},"asset":{"$ref":"#/components/schemas/Asset"},"assessmentReviewDomain":{"$ref":"#/components/schemas/BaseDomain"},"owner":{"$ref":"#/components/schemas/User"},"assignees":{"description":"The ID of the Collibra users or groups to be assigned as assignees.","type":"array","items":{"$ref":"#/components/schemas/BaseUserOrGroupAssignee"}},"isVisibleToEveryone":{"description":"Determines whether the assessment is visible to everyone. \n\nIf set to 'false', only the Owner and Assignees will be able to access the assessment.\n","type":"boolean"},"content":{"description":"A list of questions and answers for the assessment. Each question is represented by its ID and the corresponding answer.","items":{"$ref":"#/components/schemas/QuestionIdAndAnswer"}}},"required":["template"]},"BaseTemplate":{"description":"A base template object.","type":"object","properties":{"id":{"description":"The ID of the template.","type":"string","format":"uuid"}},"required":["id"]},"AssessmentStatus":{"description":"The status of an assessment. Possible values are: `DRAFT`, `SUBMITTED` or `OBSOLETE`.","type":"string"},"Asset":{"description":"The object for an asset in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset.","type":"string","format":"uuid"}},"required":["id"]},"BaseDomain":{"description":"A base object for domains in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra domain.","type":"string","format":"uuid"}},"required":["id"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"BaseUserOrGroupAssignee":{"description":"An object that represents a base user or base group as assignee.","oneOf":[{"$ref":"#/components/schemas/BaseUserAssignee"},{"$ref":"#/components/schemas/BaseGroupAssignee"}],"discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/BaseUserAssignee","GROUP":"#/components/schemas/BaseGroupAssignee"}}},"BaseUserAssignee":{"description":"The base object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"BaseGroupAssignee":{"description":"The base object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/BaseGroup"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]},"QuestionIdAndAnswer":{"description":"An object containing a question Id and its answer.","type":"object","properties":{"id":{"description":"The identifier of the question.","type":"string"},"answer":{"$ref":"#/components/schemas/Answer"},"comments":{"description":"The comments added to the question.","type":"string"}},"required":["id","answer"]},"Answer":{"description":"The object for an answer.","type":"object","oneOf":[{"$ref":"#/components/schemas/TextAnswer"},{"$ref":"#/components/schemas/HTMLAnswer"},{"$ref":"#/components/schemas/DateAnswer"},{"$ref":"#/components/schemas/BooleanAnswer"},{"$ref":"#/components/schemas/ItemsAnswer"},{"$ref":"#/components/schemas/NumberAnswer"},{"$ref":"#/components/schemas/ExpressionAnswer"},{"$ref":"#/components/schemas/AssetsAnswer"},{"$ref":"#/components/schemas/UserOrGroupsAnswer"},{"$ref":"#/components/schemas/AttachmentsAnswer"}],"discriminator":{"propertyName":"type","mapping":{"TEXT":"#/components/schemas/TextAnswer","HTML":"#/components/schemas/HTMLAnswer","DATE":"#/components/schemas/DateAnswer","BOOLEAN":"#/components/schemas/BooleanAnswer","ITEMS":"#/components/schemas/ItemsAnswer","NUMBER":"#/components/schemas/NumberAnswer","EXPRESSION":"#/components/schemas/ExpressionAnswer","ASSETS":"#/components/schemas/AssetsAnswer","USERORGROUPS":"#/components/schemas/UserOrGroupsAnswer","ATTACHMENTS":"#/components/schemas/AttachmentsAnswer"}}},"TextAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a text.","properties":{"value":{"type":"string"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"HTMLAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing an html.","properties":{"value":{"type":"string"}},"required":["value"]}]},"DateAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a date in ISO 8601 format, for example, 2017-07-21.","properties":{"value":{"type":"string","format":"date"}},"required":["value"]}]},"BooleanAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a boolean value.","properties":{"value":{"type":"boolean"}},"required":["value"]}]},"ItemsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing items.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}},"required":["value"]}]},"Item":{"description":"The object for an item.","type":"object","properties":{"id":{"description":"The ID of the selected item.","type":"string"},"value":{"description":"The value of the selected item.","type":"string"}},"required":["id"]},"NumberAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a number value.","properties":{"value":{"type":"number"}},"required":["value"]}]},"ExpressionAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing the result of an expression.","properties":{"value":{"type":"string"}},"required":["value"]}]},"AssetsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing assets.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}},"required":["value"]}]},"UserOrGroupsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing users and or groups.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupAnswer"}}},"required":["value"]}]},"UserOrGroupAnswer":{"description":"An object that represents a user or group.","discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAnswer","GROUP":"#/components/schemas/GroupAnswer"}},"oneOf":[{"$ref":"#/components/schemas/UserAnswer"},{"$ref":"#/components/schemas/GroupAnswer"}]},"UserAnswer":{"description":"The object for an user answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/User"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"GroupAnswer":{"description":"The object for a group answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/Group"}]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"AttachmentsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing attachments.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentAttachment"}}},"required":["value"]}]},"AssessmentAttachment":{"description":"An object that represents an assessment attachment.","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the attachment"},"fileName":{"type":"string","description":"Original file name of the attachment"},"createdBy":{"type":"string","format":"uuid","description":"ID of the user who created the attachment"},"createdOn":{"type":"string","format":"date-time","description":"Date and time attachment was created"}},"required":["id"]}}}} ``` ## The UpdateAssessmentRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"UpdateAssessmentRequest":{"description":"A request object to update an assessment","type":"object","properties":{"status":{"$ref":"#/components/schemas/AssessmentStatus"},"name":{"description":"The name of the assessment.","type":"string"},"assessmentReviewDomain":{"$ref":"#/components/schemas/BaseDomain"},"owner":{"$ref":"#/components/schemas/User"},"assignees":{"description":"The ID of the Collibra users or groups to be assigned as assignees.","type":"array","items":{"$ref":"#/components/schemas/BaseUserOrGroupAssignee"}},"isVisibleToEveryone":{"description":"Determines whether the assessment is visible to everyone. \n\nIf set to 'false', only the Owner and Assignees will be able to access the assessment.\n","type":"boolean"},"content":{"description":"The set of question ids and corresponding answers of the assessment.","type":"array","items":{"$ref":"#/components/schemas/QuestionIdAndAnswer"}}}},"AssessmentStatus":{"description":"The status of an assessment. Possible values are: `DRAFT`, `SUBMITTED` or `OBSOLETE`.","type":"string"},"BaseDomain":{"description":"A base object for domains in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra domain.","type":"string","format":"uuid"}},"required":["id"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"BaseUserOrGroupAssignee":{"description":"An object that represents a base user or base group as assignee.","oneOf":[{"$ref":"#/components/schemas/BaseUserAssignee"},{"$ref":"#/components/schemas/BaseGroupAssignee"}],"discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/BaseUserAssignee","GROUP":"#/components/schemas/BaseGroupAssignee"}}},"BaseUserAssignee":{"description":"The base object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"BaseGroupAssignee":{"description":"The base object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/BaseGroup"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]},"QuestionIdAndAnswer":{"description":"An object containing a question Id and its answer.","type":"object","properties":{"id":{"description":"The identifier of the question.","type":"string"},"answer":{"$ref":"#/components/schemas/Answer"},"comments":{"description":"The comments added to the question.","type":"string"}},"required":["id","answer"]},"Answer":{"description":"The object for an answer.","type":"object","oneOf":[{"$ref":"#/components/schemas/TextAnswer"},{"$ref":"#/components/schemas/HTMLAnswer"},{"$ref":"#/components/schemas/DateAnswer"},{"$ref":"#/components/schemas/BooleanAnswer"},{"$ref":"#/components/schemas/ItemsAnswer"},{"$ref":"#/components/schemas/NumberAnswer"},{"$ref":"#/components/schemas/ExpressionAnswer"},{"$ref":"#/components/schemas/AssetsAnswer"},{"$ref":"#/components/schemas/UserOrGroupsAnswer"},{"$ref":"#/components/schemas/AttachmentsAnswer"}],"discriminator":{"propertyName":"type","mapping":{"TEXT":"#/components/schemas/TextAnswer","HTML":"#/components/schemas/HTMLAnswer","DATE":"#/components/schemas/DateAnswer","BOOLEAN":"#/components/schemas/BooleanAnswer","ITEMS":"#/components/schemas/ItemsAnswer","NUMBER":"#/components/schemas/NumberAnswer","EXPRESSION":"#/components/schemas/ExpressionAnswer","ASSETS":"#/components/schemas/AssetsAnswer","USERORGROUPS":"#/components/schemas/UserOrGroupsAnswer","ATTACHMENTS":"#/components/schemas/AttachmentsAnswer"}}},"TextAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a text.","properties":{"value":{"type":"string"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"HTMLAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing an html.","properties":{"value":{"type":"string"}},"required":["value"]}]},"DateAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a date in ISO 8601 format, for example, 2017-07-21.","properties":{"value":{"type":"string","format":"date"}},"required":["value"]}]},"BooleanAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a boolean value.","properties":{"value":{"type":"boolean"}},"required":["value"]}]},"ItemsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing items.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}},"required":["value"]}]},"Item":{"description":"The object for an item.","type":"object","properties":{"id":{"description":"The ID of the selected item.","type":"string"},"value":{"description":"The value of the selected item.","type":"string"}},"required":["id"]},"NumberAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a number value.","properties":{"value":{"type":"number"}},"required":["value"]}]},"ExpressionAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing the result of an expression.","properties":{"value":{"type":"string"}},"required":["value"]}]},"AssetsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing assets.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}},"required":["value"]}]},"Asset":{"description":"The object for an asset in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset.","type":"string","format":"uuid"}},"required":["id"]},"UserOrGroupsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing users and or groups.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupAnswer"}}},"required":["value"]}]},"UserOrGroupAnswer":{"description":"An object that represents a user or group.","discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAnswer","GROUP":"#/components/schemas/GroupAnswer"}},"oneOf":[{"$ref":"#/components/schemas/UserAnswer"},{"$ref":"#/components/schemas/GroupAnswer"}]},"UserAnswer":{"description":"The object for an user answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/User"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"GroupAnswer":{"description":"The object for a group answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/Group"}]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"AttachmentsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing attachments.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentAttachment"}}},"required":["value"]}]},"AssessmentAttachment":{"description":"An object that represents an assessment attachment.","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the attachment"},"fileName":{"type":"string","description":"Original file name of the attachment"},"createdBy":{"type":"string","format":"uuid","description":"ID of the user who created the attachment"},"createdOn":{"type":"string","format":"date-time","description":"Date and time attachment was created"}},"required":["id"]}}}} ``` ## The PagedAssessments object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"PagedAssessments":{"description":"A page object containing assessments.","type":"object","properties":{"nextCursor":{"description":"The cursor pointing to the next page. If the cursor is missing, there are no additional pages of resources available after the current one.","type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Assessment"}}},"required":["results"]},"Assessment":{"description":"An assessment object.","type":"object","properties":{"id":{"description":"The ID of the assessment.","type":"string","format":"uuid"},"originAssessment":{"$ref":"#/components/schemas/OriginAssessment"},"name":{"description":"The name of the assessment.","type":"string"},"asset":{"$ref":"#/components/schemas/Asset"},"status":{"$ref":"#/components/schemas/AssessmentStatus"},"template":{"$ref":"#/components/schemas/Template"},"owner":{"$ref":"#/components/schemas/User"},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupAssignee"}},"isVisibleToEveryone":{"description":"Determines whether the assessment is visible to everyone. \n\nIf set to 'false', only the Owner and Assignees will be able to access the assessment.\n","type":"boolean","default":false},"content":{"description":"The set of questions and answers of the assessment.","type":"array","items":{"$ref":"#/components/schemas/QuestionAndAnswer"}},"createdOn":{"description":"The date and time of the assessment creation.","type":"string","format":"date-time"},"createdBy":{"$ref":"#/components/schemas/User"},"lastModifiedOn":{"description":"The date and time of the assessment last update.","type":"string","format":"date-time"},"lastModifiedBy":{"$ref":"#/components/schemas/User"},"submittedOn":{"description":"The date and time of the assessment submission.","type":"string","format":"date-time"},"submittedBy":{"$ref":"#/components/schemas/User"},"assessmentReview":{"$ref":"#/components/schemas/Asset"}},"required":["id","name","status","template","content","createdOn","createdBy","lastModifiedOn","lastModifiedBy","owner","assignees"]},"OriginAssessment":{"description":"An object that represents the origin assessment.","type":"object","properties":{"id":{"description":"The ID of the origin assessment.","type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/AssessmentStatus"}},"required":["id","status"]},"AssessmentStatus":{"description":"The status of an assessment. Possible values are: `DRAFT`, `SUBMITTED` or `OBSOLETE`.","type":"string"},"Asset":{"description":"The object for an asset in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset.","type":"string","format":"uuid"}},"required":["id"]},"Template":{"description":"A template object.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseTemplate"},{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"version":{"description":"The version of the template.","type":"integer"},"status":{"description":"The status of the template.","type":"string"},"assetType":{"$ref":"#/components/schemas/AssetType"},"notification":{"description":"Flag to indicate if notifications are on or off for the template.","type":"boolean"},"retakePermission":{"$ref":"#/components/schemas/RetakePermission"}},"required":["name","version","status"]}]},"BaseTemplate":{"description":"A base template object.","type":"object","properties":{"id":{"description":"The ID of the template.","type":"string","format":"uuid"}},"required":["id"]},"AssetType":{"description":"The object for an asset type in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset type.","type":"string","format":"uuid"}},"required":["id"]},"RetakePermission":{"description":"The retake permission is set on a template and dictates who can retake assessments of that template. \nPossible values are: \n * `All` : anyone with view access to the assessment can retake it.\n * `Owner` : only the owner of the assessment can retake it.\n * `OwnerAndAssignees` : only the owner and assignees of the assessment can retake it.\n","type":"string"},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"UserOrGroupAssignee":{"description":"An object that represents a user or group as assignee.","oneOf":[{"$ref":"#/components/schemas/UserAssignee"},{"$ref":"#/components/schemas/GroupAssignee"}],"discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAssignee","GROUP":"#/components/schemas/GroupAssignee"}}},"UserAssignee":{"description":"The object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseUserAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseUserAssignee":{"description":"The base object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"GroupAssignee":{"description":"The object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseGroupAssignee"},{"$ref":"#/components/schemas/Group"}]},"BaseGroupAssignee":{"description":"The base object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/BaseGroup"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"QuestionAndAnswer":{"description":"An object containing a question and its answer.","allOf":[{"$ref":"#/components/schemas/Question"},{"type":"object","properties":{"answer":{"$ref":"#/components/schemas/Answer"},"comments":{"description":"The comments added to the question.","type":"string"}}}]},"Question":{"description":"An object that represents a question in assessments.","type":"object","properties":{"id":{"description":"The identifier of the question.","type":"string"},"name":{"description":"The name of the question.","type":"string"},"description":{"description":"The description of the question.","type":"string"}},"required":["id"]},"Answer":{"description":"The object for an answer.","type":"object","oneOf":[{"$ref":"#/components/schemas/TextAnswer"},{"$ref":"#/components/schemas/HTMLAnswer"},{"$ref":"#/components/schemas/DateAnswer"},{"$ref":"#/components/schemas/BooleanAnswer"},{"$ref":"#/components/schemas/ItemsAnswer"},{"$ref":"#/components/schemas/NumberAnswer"},{"$ref":"#/components/schemas/ExpressionAnswer"},{"$ref":"#/components/schemas/AssetsAnswer"},{"$ref":"#/components/schemas/UserOrGroupsAnswer"},{"$ref":"#/components/schemas/AttachmentsAnswer"}],"discriminator":{"propertyName":"type","mapping":{"TEXT":"#/components/schemas/TextAnswer","HTML":"#/components/schemas/HTMLAnswer","DATE":"#/components/schemas/DateAnswer","BOOLEAN":"#/components/schemas/BooleanAnswer","ITEMS":"#/components/schemas/ItemsAnswer","NUMBER":"#/components/schemas/NumberAnswer","EXPRESSION":"#/components/schemas/ExpressionAnswer","ASSETS":"#/components/schemas/AssetsAnswer","USERORGROUPS":"#/components/schemas/UserOrGroupsAnswer","ATTACHMENTS":"#/components/schemas/AttachmentsAnswer"}}},"TextAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a text.","properties":{"value":{"type":"string"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"HTMLAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing an html.","properties":{"value":{"type":"string"}},"required":["value"]}]},"DateAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a date in ISO 8601 format, for example, 2017-07-21.","properties":{"value":{"type":"string","format":"date"}},"required":["value"]}]},"BooleanAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a boolean value.","properties":{"value":{"type":"boolean"}},"required":["value"]}]},"ItemsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing items.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}},"required":["value"]}]},"Item":{"description":"The object for an item.","type":"object","properties":{"id":{"description":"The ID of the selected item.","type":"string"},"value":{"description":"The value of the selected item.","type":"string"}},"required":["id"]},"NumberAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a number value.","properties":{"value":{"type":"number"}},"required":["value"]}]},"ExpressionAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing the result of an expression.","properties":{"value":{"type":"string"}},"required":["value"]}]},"AssetsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing assets.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}},"required":["value"]}]},"UserOrGroupsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing users and or groups.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupAnswer"}}},"required":["value"]}]},"UserOrGroupAnswer":{"description":"An object that represents a user or group.","discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAnswer","GROUP":"#/components/schemas/GroupAnswer"}},"oneOf":[{"$ref":"#/components/schemas/UserAnswer"},{"$ref":"#/components/schemas/GroupAnswer"}]},"UserAnswer":{"description":"The object for an user answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/User"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"GroupAnswer":{"description":"The object for a group answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/Group"}]},"AttachmentsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing attachments.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentAttachment"}}},"required":["value"]}]},"AssessmentAttachment":{"description":"An object that represents an assessment attachment.","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the attachment"},"fileName":{"type":"string","description":"Original file name of the attachment"},"createdBy":{"type":"string","format":"uuid","description":"ID of the user who created the attachment"},"createdOn":{"type":"string","format":"date-time","description":"Date and time attachment was created"}},"required":["id"]}}}} ``` ## The Question object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"Question":{"description":"An object that represents a question in assessments.","type":"object","properties":{"id":{"description":"The identifier of the question.","type":"string"},"name":{"description":"The name of the question.","type":"string"},"description":{"description":"The description of the question.","type":"string"}},"required":["id"]}}}} ``` ## The BaseAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]}}}} ``` ## The TextAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"TextAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a text.","properties":{"value":{"type":"string"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]}}}} ``` ## The HTMLAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"HTMLAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing an html.","properties":{"value":{"type":"string"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]}}}} ``` ## The DateAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"DateAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a date in ISO 8601 format, for example, 2017-07-21.","properties":{"value":{"type":"string","format":"date"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]}}}} ``` ## The BooleanAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"BooleanAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a boolean value.","properties":{"value":{"type":"boolean"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]}}}} ``` ## The ItemsAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"ItemsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing items.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"Item":{"description":"The object for an item.","type":"object","properties":{"id":{"description":"The ID of the selected item.","type":"string"},"value":{"description":"The value of the selected item.","type":"string"}},"required":["id"]}}}} ``` ## The NumberAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"NumberAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a number value.","properties":{"value":{"type":"number"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]}}}} ``` ## The ExpressionAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"ExpressionAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing the result of an expression.","properties":{"value":{"type":"string"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]}}}} ``` ## The AssetsAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"AssetsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing assets.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"Asset":{"description":"The object for an asset in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The UserOrGroupsAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"UserOrGroupsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing users and or groups.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupAnswer"}}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"UserOrGroupAnswer":{"description":"An object that represents a user or group.","discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAnswer","GROUP":"#/components/schemas/GroupAnswer"}},"oneOf":[{"$ref":"#/components/schemas/UserAnswer"},{"$ref":"#/components/schemas/GroupAnswer"}]},"UserAnswer":{"description":"The object for an user answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/User"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"GroupAnswer":{"description":"The object for a group answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/Group"}]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The AttachmentsAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"AttachmentsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing attachments.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentAttachment"}}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"AssessmentAttachment":{"description":"An object that represents an assessment attachment.","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the attachment"},"fileName":{"type":"string","description":"Original file name of the attachment"},"createdBy":{"type":"string","format":"uuid","description":"ID of the user who created the attachment"},"createdOn":{"type":"string","format":"date-time","description":"Date and time attachment was created"}},"required":["id"]}}}} ``` ## The BaseDomain object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"BaseDomain":{"description":"A base object for domains in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra domain.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The BaseUserOrGroupAssignee object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"BaseUserOrGroupAssignee":{"description":"An object that represents a base user or base group as assignee.","oneOf":[{"$ref":"#/components/schemas/BaseUserAssignee"},{"$ref":"#/components/schemas/BaseGroupAssignee"}],"discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/BaseUserAssignee","GROUP":"#/components/schemas/BaseGroupAssignee"}}},"BaseUserAssignee":{"description":"The base object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"BaseGroupAssignee":{"description":"The base object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/BaseGroup"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The UserOrGroupAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"UserOrGroupAnswer":{"description":"An object that represents a user or group.","discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAnswer","GROUP":"#/components/schemas/GroupAnswer"}},"oneOf":[{"$ref":"#/components/schemas/UserAnswer"},{"$ref":"#/components/schemas/GroupAnswer"}]},"UserAnswer":{"description":"The object for an user answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/User"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"GroupAnswer":{"description":"The object for a group answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/Group"}]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The UserAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"UserAnswer":{"description":"The object for an user answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/User"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The GroupAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"GroupAnswer":{"description":"The object for a group answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/Group"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The Answer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"Answer":{"description":"The object for an answer.","type":"object","oneOf":[{"$ref":"#/components/schemas/TextAnswer"},{"$ref":"#/components/schemas/HTMLAnswer"},{"$ref":"#/components/schemas/DateAnswer"},{"$ref":"#/components/schemas/BooleanAnswer"},{"$ref":"#/components/schemas/ItemsAnswer"},{"$ref":"#/components/schemas/NumberAnswer"},{"$ref":"#/components/schemas/ExpressionAnswer"},{"$ref":"#/components/schemas/AssetsAnswer"},{"$ref":"#/components/schemas/UserOrGroupsAnswer"},{"$ref":"#/components/schemas/AttachmentsAnswer"}],"discriminator":{"propertyName":"type","mapping":{"TEXT":"#/components/schemas/TextAnswer","HTML":"#/components/schemas/HTMLAnswer","DATE":"#/components/schemas/DateAnswer","BOOLEAN":"#/components/schemas/BooleanAnswer","ITEMS":"#/components/schemas/ItemsAnswer","NUMBER":"#/components/schemas/NumberAnswer","EXPRESSION":"#/components/schemas/ExpressionAnswer","ASSETS":"#/components/schemas/AssetsAnswer","USERORGROUPS":"#/components/schemas/UserOrGroupsAnswer","ATTACHMENTS":"#/components/schemas/AttachmentsAnswer"}}},"TextAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a text.","properties":{"value":{"type":"string"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"HTMLAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing an html.","properties":{"value":{"type":"string"}},"required":["value"]}]},"DateAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a date in ISO 8601 format, for example, 2017-07-21.","properties":{"value":{"type":"string","format":"date"}},"required":["value"]}]},"BooleanAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a boolean value.","properties":{"value":{"type":"boolean"}},"required":["value"]}]},"ItemsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing items.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}},"required":["value"]}]},"Item":{"description":"The object for an item.","type":"object","properties":{"id":{"description":"The ID of the selected item.","type":"string"},"value":{"description":"The value of the selected item.","type":"string"}},"required":["id"]},"NumberAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a number value.","properties":{"value":{"type":"number"}},"required":["value"]}]},"ExpressionAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing the result of an expression.","properties":{"value":{"type":"string"}},"required":["value"]}]},"AssetsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing assets.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}},"required":["value"]}]},"Asset":{"description":"The object for an asset in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset.","type":"string","format":"uuid"}},"required":["id"]},"UserOrGroupsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing users and or groups.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupAnswer"}}},"required":["value"]}]},"UserOrGroupAnswer":{"description":"An object that represents a user or group.","discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAnswer","GROUP":"#/components/schemas/GroupAnswer"}},"oneOf":[{"$ref":"#/components/schemas/UserAnswer"},{"$ref":"#/components/schemas/GroupAnswer"}]},"UserAnswer":{"description":"The object for an user answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/User"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"GroupAnswer":{"description":"The object for a group answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/Group"}]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]},"AttachmentsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing attachments.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentAttachment"}}},"required":["value"]}]},"AssessmentAttachment":{"description":"An object that represents an assessment attachment.","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the attachment"},"fileName":{"type":"string","description":"Original file name of the attachment"},"createdBy":{"type":"string","format":"uuid","description":"ID of the user who created the attachment"},"createdOn":{"type":"string","format":"date-time","description":"Date and time attachment was created"}},"required":["id"]}}}} ``` ## The QuestionAndAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"QuestionAndAnswer":{"description":"An object containing a question and its answer.","allOf":[{"$ref":"#/components/schemas/Question"},{"type":"object","properties":{"answer":{"$ref":"#/components/schemas/Answer"},"comments":{"description":"The comments added to the question.","type":"string"}}}]},"Question":{"description":"An object that represents a question in assessments.","type":"object","properties":{"id":{"description":"The identifier of the question.","type":"string"},"name":{"description":"The name of the question.","type":"string"},"description":{"description":"The description of the question.","type":"string"}},"required":["id"]},"Answer":{"description":"The object for an answer.","type":"object","oneOf":[{"$ref":"#/components/schemas/TextAnswer"},{"$ref":"#/components/schemas/HTMLAnswer"},{"$ref":"#/components/schemas/DateAnswer"},{"$ref":"#/components/schemas/BooleanAnswer"},{"$ref":"#/components/schemas/ItemsAnswer"},{"$ref":"#/components/schemas/NumberAnswer"},{"$ref":"#/components/schemas/ExpressionAnswer"},{"$ref":"#/components/schemas/AssetsAnswer"},{"$ref":"#/components/schemas/UserOrGroupsAnswer"},{"$ref":"#/components/schemas/AttachmentsAnswer"}],"discriminator":{"propertyName":"type","mapping":{"TEXT":"#/components/schemas/TextAnswer","HTML":"#/components/schemas/HTMLAnswer","DATE":"#/components/schemas/DateAnswer","BOOLEAN":"#/components/schemas/BooleanAnswer","ITEMS":"#/components/schemas/ItemsAnswer","NUMBER":"#/components/schemas/NumberAnswer","EXPRESSION":"#/components/schemas/ExpressionAnswer","ASSETS":"#/components/schemas/AssetsAnswer","USERORGROUPS":"#/components/schemas/UserOrGroupsAnswer","ATTACHMENTS":"#/components/schemas/AttachmentsAnswer"}}},"TextAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a text.","properties":{"value":{"type":"string"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"HTMLAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing an html.","properties":{"value":{"type":"string"}},"required":["value"]}]},"DateAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a date in ISO 8601 format, for example, 2017-07-21.","properties":{"value":{"type":"string","format":"date"}},"required":["value"]}]},"BooleanAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a boolean value.","properties":{"value":{"type":"boolean"}},"required":["value"]}]},"ItemsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing items.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}},"required":["value"]}]},"Item":{"description":"The object for an item.","type":"object","properties":{"id":{"description":"The ID of the selected item.","type":"string"},"value":{"description":"The value of the selected item.","type":"string"}},"required":["id"]},"NumberAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a number value.","properties":{"value":{"type":"number"}},"required":["value"]}]},"ExpressionAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing the result of an expression.","properties":{"value":{"type":"string"}},"required":["value"]}]},"AssetsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing assets.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}},"required":["value"]}]},"Asset":{"description":"The object for an asset in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset.","type":"string","format":"uuid"}},"required":["id"]},"UserOrGroupsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing users and or groups.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupAnswer"}}},"required":["value"]}]},"UserOrGroupAnswer":{"description":"An object that represents a user or group.","discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAnswer","GROUP":"#/components/schemas/GroupAnswer"}},"oneOf":[{"$ref":"#/components/schemas/UserAnswer"},{"$ref":"#/components/schemas/GroupAnswer"}]},"UserAnswer":{"description":"The object for an user answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/User"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"GroupAnswer":{"description":"The object for a group answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/Group"}]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]},"AttachmentsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing attachments.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentAttachment"}}},"required":["value"]}]},"AssessmentAttachment":{"description":"An object that represents an assessment attachment.","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the attachment"},"fileName":{"type":"string","description":"Original file name of the attachment"},"createdBy":{"type":"string","format":"uuid","description":"ID of the user who created the attachment"},"createdOn":{"type":"string","format":"date-time","description":"Date and time attachment was created"}},"required":["id"]}}}} ``` ## The QuestionIdAndAnswer object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"QuestionIdAndAnswer":{"description":"An object containing a question Id and its answer.","type":"object","properties":{"id":{"description":"The identifier of the question.","type":"string"},"answer":{"$ref":"#/components/schemas/Answer"},"comments":{"description":"The comments added to the question.","type":"string"}},"required":["id","answer"]},"Answer":{"description":"The object for an answer.","type":"object","oneOf":[{"$ref":"#/components/schemas/TextAnswer"},{"$ref":"#/components/schemas/HTMLAnswer"},{"$ref":"#/components/schemas/DateAnswer"},{"$ref":"#/components/schemas/BooleanAnswer"},{"$ref":"#/components/schemas/ItemsAnswer"},{"$ref":"#/components/schemas/NumberAnswer"},{"$ref":"#/components/schemas/ExpressionAnswer"},{"$ref":"#/components/schemas/AssetsAnswer"},{"$ref":"#/components/schemas/UserOrGroupsAnswer"},{"$ref":"#/components/schemas/AttachmentsAnswer"}],"discriminator":{"propertyName":"type","mapping":{"TEXT":"#/components/schemas/TextAnswer","HTML":"#/components/schemas/HTMLAnswer","DATE":"#/components/schemas/DateAnswer","BOOLEAN":"#/components/schemas/BooleanAnswer","ITEMS":"#/components/schemas/ItemsAnswer","NUMBER":"#/components/schemas/NumberAnswer","EXPRESSION":"#/components/schemas/ExpressionAnswer","ASSETS":"#/components/schemas/AssetsAnswer","USERORGROUPS":"#/components/schemas/UserOrGroupsAnswer","ATTACHMENTS":"#/components/schemas/AttachmentsAnswer"}}},"TextAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a text.","properties":{"value":{"type":"string"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"HTMLAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing an html.","properties":{"value":{"type":"string"}},"required":["value"]}]},"DateAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a date in ISO 8601 format, for example, 2017-07-21.","properties":{"value":{"type":"string","format":"date"}},"required":["value"]}]},"BooleanAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a boolean value.","properties":{"value":{"type":"boolean"}},"required":["value"]}]},"ItemsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing items.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}},"required":["value"]}]},"Item":{"description":"The object for an item.","type":"object","properties":{"id":{"description":"The ID of the selected item.","type":"string"},"value":{"description":"The value of the selected item.","type":"string"}},"required":["id"]},"NumberAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a number value.","properties":{"value":{"type":"number"}},"required":["value"]}]},"ExpressionAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing the result of an expression.","properties":{"value":{"type":"string"}},"required":["value"]}]},"AssetsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing assets.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}},"required":["value"]}]},"Asset":{"description":"The object for an asset in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset.","type":"string","format":"uuid"}},"required":["id"]},"UserOrGroupsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing users and or groups.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupAnswer"}}},"required":["value"]}]},"UserOrGroupAnswer":{"description":"An object that represents a user or group.","discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAnswer","GROUP":"#/components/schemas/GroupAnswer"}},"oneOf":[{"$ref":"#/components/schemas/UserAnswer"},{"$ref":"#/components/schemas/GroupAnswer"}]},"UserAnswer":{"description":"The object for an user answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/User"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"GroupAnswer":{"description":"The object for a group answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/Group"}]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]},"AttachmentsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing attachments.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentAttachment"}}},"required":["value"]}]},"AssessmentAttachment":{"description":"An object that represents an assessment attachment.","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the attachment"},"fileName":{"type":"string","description":"Original file name of the attachment"},"createdBy":{"type":"string","format":"uuid","description":"ID of the user who created the attachment"},"createdOn":{"type":"string","format":"date-time","description":"Date and time attachment was created"}},"required":["id"]}}}} ``` ## The Item object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"Item":{"description":"The object for an item.","type":"object","properties":{"id":{"description":"The ID of the selected item.","type":"string"},"value":{"description":"The value of the selected item.","type":"string"}},"required":["id"]}}}} ``` ## The AssetType object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"AssetType":{"description":"The object for an asset type in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset type.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The Asset object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"Asset":{"description":"The object for an asset in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The User object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The BaseGroup object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The Group object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The BaseTypeUserOrGroup object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]}}}} ``` ## The BaseTypedUserOrGroupAssignee object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]}}}} ``` ## The BaseUserAssignee object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"BaseUserAssignee":{"description":"The base object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The UserAssignee object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"UserAssignee":{"description":"The object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseUserAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseUserAssignee":{"description":"The base object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The BaseGroupAssignee object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"BaseGroupAssignee":{"description":"The base object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/BaseGroup"}]},"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The GroupAssignee object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"GroupAssignee":{"description":"The object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseGroupAssignee"},{"$ref":"#/components/schemas/Group"}]},"BaseGroupAssignee":{"description":"The base object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/BaseGroup"}]},"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]}}}} ``` ## The UserOrGroupAssignee object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"UserOrGroupAssignee":{"description":"An object that represents a user or group as assignee.","oneOf":[{"$ref":"#/components/schemas/UserAssignee"},{"$ref":"#/components/schemas/GroupAssignee"}],"discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAssignee","GROUP":"#/components/schemas/GroupAssignee"}}},"UserAssignee":{"description":"The object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseUserAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseUserAssignee":{"description":"The base object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"GroupAssignee":{"description":"The object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseGroupAssignee"},{"$ref":"#/components/schemas/Group"}]},"BaseGroupAssignee":{"description":"The base object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/BaseGroup"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]}}}} ``` ## The BaseTemplate object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"BaseTemplate":{"description":"A base template object.","type":"object","properties":{"id":{"description":"The ID of the template.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The Template object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"Template":{"description":"A template object.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseTemplate"},{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"version":{"description":"The version of the template.","type":"integer"},"status":{"description":"The status of the template.","type":"string"},"assetType":{"$ref":"#/components/schemas/AssetType"},"notification":{"description":"Flag to indicate if notifications are on or off for the template.","type":"boolean"},"retakePermission":{"$ref":"#/components/schemas/RetakePermission"}},"required":["name","version","status"]}]},"BaseTemplate":{"description":"A base template object.","type":"object","properties":{"id":{"description":"The ID of the template.","type":"string","format":"uuid"}},"required":["id"]},"AssetType":{"description":"The object for an asset type in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset type.","type":"string","format":"uuid"}},"required":["id"]},"RetakePermission":{"description":"The retake permission is set on a template and dictates who can retake assessments of that template. \nPossible values are: \n * `All` : anyone with view access to the assessment can retake it.\n * `Owner` : only the owner of the assessment can retake it.\n * `OwnerAndAssignees` : only the owner and assignees of the assessment can retake it.\n","type":"string"}}}} ``` ## The OriginAssessment object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"OriginAssessment":{"description":"An object that represents the origin assessment.","type":"object","properties":{"id":{"description":"The ID of the origin assessment.","type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/AssessmentStatus"}},"required":["id","status"]},"AssessmentStatus":{"description":"The status of an assessment. Possible values are: `DRAFT`, `SUBMITTED` or `OBSOLETE`.","type":"string"}}}} ``` ## The PagedTemplates object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"PagedTemplates":{"description":"A page object containing templates.","type":"object","properties":{"nextCursor":{"description":"The cursor pointing to the next page. If the cursor is missing, there are no additional pages of resources available after the current one.","type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Template"}}},"required":["results"]},"Template":{"description":"A template object.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseTemplate"},{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"version":{"description":"The version of the template.","type":"integer"},"status":{"description":"The status of the template.","type":"string"},"assetType":{"$ref":"#/components/schemas/AssetType"},"notification":{"description":"Flag to indicate if notifications are on or off for the template.","type":"boolean"},"retakePermission":{"$ref":"#/components/schemas/RetakePermission"}},"required":["name","version","status"]}]},"BaseTemplate":{"description":"A base template object.","type":"object","properties":{"id":{"description":"The ID of the template.","type":"string","format":"uuid"}},"required":["id"]},"AssetType":{"description":"The object for an asset type in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset type.","type":"string","format":"uuid"}},"required":["id"]},"RetakePermission":{"description":"The retake permission is set on a template and dictates who can retake assessments of that template. \nPossible values are: \n * `All` : anyone with view access to the assessment can retake it.\n * `Owner` : only the owner of the assessment can retake it.\n * `OwnerAndAssignees` : only the owner and assignees of the assessment can retake it.\n","type":"string"}}}} ``` ## The AssessmentStatus object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"AssessmentStatus":{"description":"The status of an assessment. Possible values are: `DRAFT`, `SUBMITTED` or `OBSOLETE`.","type":"string"}}}} ``` ## The Assessment object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"Assessment":{"description":"An assessment object.","type":"object","properties":{"id":{"description":"The ID of the assessment.","type":"string","format":"uuid"},"originAssessment":{"$ref":"#/components/schemas/OriginAssessment"},"name":{"description":"The name of the assessment.","type":"string"},"asset":{"$ref":"#/components/schemas/Asset"},"status":{"$ref":"#/components/schemas/AssessmentStatus"},"template":{"$ref":"#/components/schemas/Template"},"owner":{"$ref":"#/components/schemas/User"},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupAssignee"}},"isVisibleToEveryone":{"description":"Determines whether the assessment is visible to everyone. \n\nIf set to 'false', only the Owner and Assignees will be able to access the assessment.\n","type":"boolean","default":false},"content":{"description":"The set of questions and answers of the assessment.","type":"array","items":{"$ref":"#/components/schemas/QuestionAndAnswer"}},"createdOn":{"description":"The date and time of the assessment creation.","type":"string","format":"date-time"},"createdBy":{"$ref":"#/components/schemas/User"},"lastModifiedOn":{"description":"The date and time of the assessment last update.","type":"string","format":"date-time"},"lastModifiedBy":{"$ref":"#/components/schemas/User"},"submittedOn":{"description":"The date and time of the assessment submission.","type":"string","format":"date-time"},"submittedBy":{"$ref":"#/components/schemas/User"},"assessmentReview":{"$ref":"#/components/schemas/Asset"}},"required":["id","name","status","template","content","createdOn","createdBy","lastModifiedOn","lastModifiedBy","owner","assignees"]},"OriginAssessment":{"description":"An object that represents the origin assessment.","type":"object","properties":{"id":{"description":"The ID of the origin assessment.","type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/AssessmentStatus"}},"required":["id","status"]},"AssessmentStatus":{"description":"The status of an assessment. Possible values are: `DRAFT`, `SUBMITTED` or `OBSOLETE`.","type":"string"},"Asset":{"description":"The object for an asset in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset.","type":"string","format":"uuid"}},"required":["id"]},"Template":{"description":"A template object.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseTemplate"},{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"version":{"description":"The version of the template.","type":"integer"},"status":{"description":"The status of the template.","type":"string"},"assetType":{"$ref":"#/components/schemas/AssetType"},"notification":{"description":"Flag to indicate if notifications are on or off for the template.","type":"boolean"},"retakePermission":{"$ref":"#/components/schemas/RetakePermission"}},"required":["name","version","status"]}]},"BaseTemplate":{"description":"A base template object.","type":"object","properties":{"id":{"description":"The ID of the template.","type":"string","format":"uuid"}},"required":["id"]},"AssetType":{"description":"The object for an asset type in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset type.","type":"string","format":"uuid"}},"required":["id"]},"RetakePermission":{"description":"The retake permission is set on a template and dictates who can retake assessments of that template. \nPossible values are: \n * `All` : anyone with view access to the assessment can retake it.\n * `Owner` : only the owner of the assessment can retake it.\n * `OwnerAndAssignees` : only the owner and assignees of the assessment can retake it.\n","type":"string"},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"UserOrGroupAssignee":{"description":"An object that represents a user or group as assignee.","oneOf":[{"$ref":"#/components/schemas/UserAssignee"},{"$ref":"#/components/schemas/GroupAssignee"}],"discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAssignee","GROUP":"#/components/schemas/GroupAssignee"}}},"UserAssignee":{"description":"The object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseUserAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseUserAssignee":{"description":"The base object for a Collibra user as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/User"}]},"BaseTypedUserOrGroupAssignee":{"description":"A base object for users and groups that are assignees.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"GroupAssignee":{"description":"The object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseGroupAssignee"},{"$ref":"#/components/schemas/Group"}]},"BaseGroupAssignee":{"description":"The base object for a Collibra user group as an assignee.","allOf":[{"$ref":"#/components/schemas/BaseTypedUserOrGroupAssignee"},{"$ref":"#/components/schemas/BaseGroup"}]},"BaseGroup":{"description":"The base object for a user group in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra group.","type":"string","format":"uuid"}},"required":["id"]},"Group":{"description":"The object for a user group in Collibra.","allOf":[{"$ref":"#/components/schemas/BaseGroup"},{"type":"object"}]},"QuestionAndAnswer":{"description":"An object containing a question and its answer.","allOf":[{"$ref":"#/components/schemas/Question"},{"type":"object","properties":{"answer":{"$ref":"#/components/schemas/Answer"},"comments":{"description":"The comments added to the question.","type":"string"}}}]},"Question":{"description":"An object that represents a question in assessments.","type":"object","properties":{"id":{"description":"The identifier of the question.","type":"string"},"name":{"description":"The name of the question.","type":"string"},"description":{"description":"The description of the question.","type":"string"}},"required":["id"]},"Answer":{"description":"The object for an answer.","type":"object","oneOf":[{"$ref":"#/components/schemas/TextAnswer"},{"$ref":"#/components/schemas/HTMLAnswer"},{"$ref":"#/components/schemas/DateAnswer"},{"$ref":"#/components/schemas/BooleanAnswer"},{"$ref":"#/components/schemas/ItemsAnswer"},{"$ref":"#/components/schemas/NumberAnswer"},{"$ref":"#/components/schemas/ExpressionAnswer"},{"$ref":"#/components/schemas/AssetsAnswer"},{"$ref":"#/components/schemas/UserOrGroupsAnswer"},{"$ref":"#/components/schemas/AttachmentsAnswer"}],"discriminator":{"propertyName":"type","mapping":{"TEXT":"#/components/schemas/TextAnswer","HTML":"#/components/schemas/HTMLAnswer","DATE":"#/components/schemas/DateAnswer","BOOLEAN":"#/components/schemas/BooleanAnswer","ITEMS":"#/components/schemas/ItemsAnswer","NUMBER":"#/components/schemas/NumberAnswer","EXPRESSION":"#/components/schemas/ExpressionAnswer","ASSETS":"#/components/schemas/AssetsAnswer","USERORGROUPS":"#/components/schemas/UserOrGroupsAnswer","ATTACHMENTS":"#/components/schemas/AttachmentsAnswer"}}},"TextAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a text.","properties":{"value":{"type":"string"}},"required":["value"]}]},"BaseAnswer":{"description":"The base object for an answer.","type":"object","properties":{"type":{"description":"The type of the answer to the question. Possible values are: `TEXT`, `HTML`, `DATE`, `BOOLEAN`, `ITEMS`, `NUMBER`, `EXPRESSION` or `ASSETS`.","type":"string"}},"required":["type"]},"HTMLAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing an html.","properties":{"value":{"type":"string"}},"required":["value"]}]},"DateAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a date in ISO 8601 format, for example, 2017-07-21.","properties":{"value":{"type":"string","format":"date"}},"required":["value"]}]},"BooleanAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a boolean value.","properties":{"value":{"type":"boolean"}},"required":["value"]}]},"ItemsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing items.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}},"required":["value"]}]},"Item":{"description":"The object for an item.","type":"object","properties":{"id":{"description":"The ID of the selected item.","type":"string"},"value":{"description":"The value of the selected item.","type":"string"}},"required":["id"]},"NumberAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing a number value.","properties":{"value":{"type":"number"}},"required":["value"]}]},"ExpressionAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing the result of an expression.","properties":{"value":{"type":"string"}},"required":["value"]}]},"AssetsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing assets.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}},"required":["value"]}]},"UserOrGroupsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing users and or groups.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupAnswer"}}},"required":["value"]}]},"UserOrGroupAnswer":{"description":"An object that represents a user or group.","discriminator":{"propertyName":"type","mapping":{"USER":"#/components/schemas/UserAnswer","GROUP":"#/components/schemas/GroupAnswer"}},"oneOf":[{"$ref":"#/components/schemas/UserAnswer"},{"$ref":"#/components/schemas/GroupAnswer"}]},"UserAnswer":{"description":"The object for an user answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/User"}]},"BaseTypeUserOrGroup":{"description":"Type identifying a user or group.","type":"object","properties":{"type":{"description":"Possible values are: `USER` or `GROUP`.","type":"string"}},"required":["type"]},"GroupAnswer":{"description":"The object for a group answer.","allOf":[{"$ref":"#/components/schemas/BaseTypeUserOrGroup"},{"$ref":"#/components/schemas/Group"}]},"AttachmentsAnswer":{"allOf":[{"$ref":"#/components/schemas/BaseAnswer"},{"type":"object","description":"An answer object containing attachments.","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentAttachment"}}},"required":["value"]}]},"AssessmentAttachment":{"description":"An object that represents an assessment attachment.","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the attachment"},"fileName":{"type":"string","description":"Original file name of the attachment"},"createdBy":{"type":"string","format":"uuid","description":"ID of the user who created the attachment"},"createdOn":{"type":"string","format":"date-time","description":"Date and time attachment was created"}},"required":["id"]}}}} ``` ## The AssessmentAttachment object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"AssessmentAttachment":{"description":"An object that represents an assessment attachment.","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the attachment"},"fileName":{"type":"string","description":"Original file name of the attachment"},"createdBy":{"type":"string","format":"uuid","description":"ID of the user who created the attachment"},"createdOn":{"type":"string","format":"date-time","description":"Date and time attachment was created"}},"required":["id"]}}}} ``` ## The RetakeAssessmentRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"RetakeAssessmentRequest":{"description":"A request object to retake an assessment","type":"object","properties":{"owner":{"$ref":"#/components/schemas/User"},"asset":{"$ref":"#/components/schemas/Asset"}}},"User":{"description":"The object for a user in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra user.","type":"string","format":"uuid"}},"required":["id"]},"Asset":{"description":"The object for an asset in Collibra.","type":"object","properties":{"id":{"description":"The ID of the Collibra asset.","type":"string","format":"uuid"}},"required":["id"]}}}} ``` ## The RetakePermission object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"RetakePermission":{"description":"The retake permission is set on a template and dictates who can retake assessments of that template. \nPossible values are: \n * `All` : anyone with view access to the assessment can retake it.\n * `Owner` : only the owner of the assessment can retake it.\n * `OwnerAndAssignees` : only the owner and assignees of the assessment can retake it.\n","type":"string"}}}} ``` ## The DownloadFile object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"DownloadFile":{"type":"string","format":"binary"}}}} ``` ## The StandardErrorResponse object ```json {"openapi":"3.0.3","info":{"title":"Collibra Assessments API","version":"2.0.0"},"components":{"schemas":{"StandardErrorResponse":{"description":"A standard error response object.","type":"object","properties":{"statusCode":{"description":"HTTP response code.","type":"integer"},"titleMessage":{"description":"The title of the error message.","type":"string"},"helpMessage":{"description":"A message containing actions you can take regarding the error.","type":"string"},"userMessage":{"description":"A user friendly error message.","type":"string"},"errorCode":{"description":"An error code identifier.","type":"string"}},"required":["statusCode","userMessage"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.collibra.com/api/references/assessments-v2/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.