Assessments

Take actions on assessments.

Retrieve an assessment by ID

get

Returns information about the assessment with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters

idstring · uuidRequired

The ID of the assessment.

Responses

200

Example of a response for retrieving an assessment.

application/json

An assessment object.

idstring · uuidRequired

The ID of the assessment.

Example: 7460c00f-3b12-4238-b68d-4ec4ea8bf9f7

namestringRequired

The name of the assessment.

Example: Direct Marketing

statusstringRequired

The status of an assessment. Possible values are: DRAFT, SUBMITTED or OBSOLETE.

isVisibleToEveryonebooleanOptional

Determines whether the assessment is visible to everyone.

If set to 'false', only the Owner and Assignees will be able to access the assessment.

Default: falseExample: true

createdOnstring · date-timeRequired

The date and time of the assessment creation.

Example: 2023-07-10T15:03:10.433Z

lastModifiedOnstring · date-timeRequired

The date and time of the assessment last update.

Example: 2023-07-10T15:03:10.433Z

submittedOnstring · date-timeOptional

The date and time of the assessment submission.

Example: 2023-07-10T15:10:10.433Z

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

There was an error processing the request.

application/json

get/assessments/{id}

HTTPcURLJavaScriptPython

GET /rest/assessments/v2/assessments/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "07ed39f5-be3b-4406-a09e-3c78a8734261",
  "originAssessment": {
    "id": "36289c9a-4dbe-42ee-97cd-68cd89ed0c69",
    "status": "SUBMITTED"
  },
  "name": "Direct Marketing",
  "asset": {
    "id": "9e6ba6fa-ae24-41c8-9b42-08e7c4231689"
  },
  "status": "SUBMITTED",
  "template": {
    "id": "c8643d4d-f9f8-4484-b9c2-d0f3432e295f",
    "name": "Legal Checks",
    "version": 1,
    "status": "PUBLISHED",
    "assetType": {
      "id": "0b781899-3dd2-4746-bc98-65daef8f1efa"
    }
  },
  "owner": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assignees": [
    {
      "type": "USER",
      "id": "d615a9fe-8d8c-4287-80aa-5b058519ca45"
    },
    {
      "type": "GROUP",
      "id": "387b34f5-eac8-467c-89b6-5ee7c2e7368b"
    }
  ],
  "content": [
    {
      "id": "legalBasisSpecified",
      "name": "Are all legal bases specified?",
      "answer": {
        "type": "BOOLEAN",
        "value": true
      },
      "comment": "We use Legitimate interest as the legal basis."
    }
  ],
  "createdOn": "2023-07-10T15:03:10.433Z",
  "createdBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "lastModifiedOn": "2023-07-10T18:43:10.433Z",
  "lastModifiedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "submittedOn": "2023-07-10T18:43:10.433Z",
  "submittedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assessmentReview": {
    "id": "b50c1532-4f84-4551-bfc8-a123845fedf5"
  }
}

Delete an assessment

delete

Deletes the assessment with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters

idstring · uuidRequired

The ID of the assessment to be deleted.

Responses

204

The assessment has been deleted.

No content

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

There was an error processing the request.

application/json

delete/assessments/{id}

HTTPcURLJavaScriptPython

DELETE /rest/assessments/v2/assessments/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Update an assessment

patch

Updates the assessment with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters

idstring · uuidRequired

The ID of the assessment to be updated.

Body

application/json

A request object to update an assessment

statusstringOptional

The status of an assessment. Possible values are: DRAFT, SUBMITTED or OBSOLETE.

namestringOptional

The name of the assessment.

Example: Legal Checks

isVisibleToEveryonebooleanOptional

Determines whether the assessment is visible to everyone.

If set to 'false', only the Owner and Assignees will be able to access the assessment.

Example: true

Responses

200

Example of a response for updating an assessment.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

There was an error processing the request.

application/json

patch/assessments/{id}

HTTPcURLJavaScriptPython

PATCH /rest/assessments/v2/assessments/{id} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 381

{
  "status": "text",
  "name": "Legal Checks",
  "assessmentReviewDomain": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "owner": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assignees": [
    {
      "type": "USER",
      "id": "d615a9fe-8d8c-4287-80aa-5b058519ca45"
    }
  ],
  "isVisibleToEveryone": true,
  "content": [
    {
      "id": "question1",
      "answer": {
        "type": "TEXT",
        "value": "This is the text of the answer."
      },
      "comments": "text"
    }
  ]
}

{
  "id": "07ed39f5-be3b-4406-a09e-3c78a8734261",
  "originAssessment": {
    "id": "36289c9a-4dbe-42ee-97cd-68cd89ed0c69",
    "status": "SUBMITTED"
  },
  "name": "Direct Marketing",
  "asset": {
    "id": "9e6ba6fa-ae24-41c8-9b42-08e7c4231689"
  },
  "status": "SUBMITTED",
  "template": {
    "id": "c8643d4d-f9f8-4484-b9c2-d0f3432e295f",
    "name": "Legal Checks",
    "version": 1,
    "status": "PUBLISHED",
    "assetType": {
      "id": "0b781899-3dd2-4746-bc98-65daef8f1efa"
    }
  },
  "owner": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assignees": [
    {
      "type": "USER",
      "id": "d615a9fe-8d8c-4287-80aa-5b058519ca45"
    },
    {
      "type": "GROUP",
      "id": "387b34f5-eac8-467c-89b6-5ee7c2e7368b"
    }
  ],
  "content": [
    {
      "id": "legalBasisSpecified",
      "name": "Are all legal bases specified?",
      "answer": {
        "type": "BOOLEAN",
        "value": true
      },
      "comment": "We use Legitimate interest as the legal basis."
    }
  ],
  "createdOn": "2023-07-10T15:03:10.433Z",
  "createdBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "lastModifiedOn": "2023-07-10T18:43:10.433Z",
  "lastModifiedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "submittedOn": "2023-07-10T18:43:10.433Z",
  "submittedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assessmentReview": {
    "id": "b50c1532-4f84-4551-bfc8-a123845fedf5"
  }
}

List attachments for an assessment

get

Returns a list of attachments for the specified assessment.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters

idstring · uuidRequired

The ID of the assessment.

Responses

200

Example of a response for listing assessments.

application/json

An object that represents an assessment attachment.

idstring · uuidRequired

ID of the attachment

Example: 85a9c637-e27e-4a7f-80f1-6db07e336d04

fileNamestringOptional

Original file name of the attachment

Example: evidence_document.pdf

createdBystring · uuidOptional

ID of the user who created the attachment

Example: 0e787414-fd78-48a0-bfdd-69411b26c65b

createdOnstring · date-timeOptional

Date and time attachment was created

Example: 2023-07-10T18:43:10.433Z

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

There was an error processing the request.

application/json

get/assessments/{id}/attachments

HTTPcURLJavaScriptPython

GET /rest/assessments/v2/assessments/{id}/attachments HTTP/1.1
Authorization: Basic username:password
Accept: */*

[
  {
    "id": "85a9c637-e27e-4a7f-80f1-6db07e336d04",
    "fileName": "evidence_document.pdf",
    "createdBy": "0e787414-fd78-48a0-bfdd-69411b26c65b",
    "createdOn": "2023-07-10T18:43:10.433Z"
  }
]

Upload attachment for an assessment

post

Upload a file attachment to an assessment. The attachment id can then be used in answers.

Authorizations

basicAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters

idstring · uuidRequired

The ID of the assessment.

Body

multipart/form-data

filestring · binaryRequired

The file to upload

Responses

201

Example of a response for creating an attachment for an assessment.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

There was an error processing the request.

application/json

post/assessments/{id}/attachments

HTTPcURLJavaScriptPython

POST /rest/assessments/v2/assessments/{id}/attachments HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "id": "85a9c637-e27e-4a7f-80f1-6db07e336d04",
  "fileName": "evidence_document.pdf",
  "createdBy": "0e787414-fd78-48a0-bfdd-69411b26c65b",
  "createdOn": "2023-07-10T18:43:10.433Z"
}

Download attachment file

get

Download the file content of a specific attachment.

Authorizations

basicAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters

idstring · uuidRequired

The ID of the assessment.

attachmentIdstring · uuidRequired

ID of the attachment to download

Responses

200

Attachment file content

application/octet-stream

string · binaryOptional

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

There was an error processing the request.

application/json

get/assessments/{id}/attachments/{attachmentId}/file

HTTPcURLJavaScriptPython

GET /rest/assessments/v2/assessments/{id}/attachments/{attachmentId}/file HTTP/1.1
Authorization: Basic username:password
Accept: */*

binary

Retrieve an assessment by assessment review ID

get

Returns information about the assessment with the specified assessment review asset ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters

idstring · uuidRequired

The ID of the assessment review asset.

Responses

200

Example of a response for retrieving an assessment.

application/json

An assessment object.

idstring · uuidRequired

The ID of the assessment.

Example: 7460c00f-3b12-4238-b68d-4ec4ea8bf9f7

namestringRequired

The name of the assessment.

Example: Direct Marketing

statusstringRequired

The status of an assessment. Possible values are: DRAFT, SUBMITTED or OBSOLETE.

isVisibleToEveryonebooleanOptional

Determines whether the assessment is visible to everyone.

If set to 'false', only the Owner and Assignees will be able to access the assessment.

Default: falseExample: true

createdOnstring · date-timeRequired

The date and time of the assessment creation.

Example: 2023-07-10T15:03:10.433Z

lastModifiedOnstring · date-timeRequired

The date and time of the assessment last update.

Example: 2023-07-10T15:03:10.433Z

submittedOnstring · date-timeOptional

The date and time of the assessment submission.

Example: 2023-07-10T15:10:10.433Z

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

There was an error processing the request.

application/json

get/assessments/by/assessmentReview/{id}

HTTPcURLJavaScriptPython

GET /rest/assessments/v2/assessments/by/assessmentReview/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "07ed39f5-be3b-4406-a09e-3c78a8734261",
  "originAssessment": {
    "id": "36289c9a-4dbe-42ee-97cd-68cd89ed0c69",
    "status": "SUBMITTED"
  },
  "name": "Direct Marketing",
  "asset": {
    "id": "9e6ba6fa-ae24-41c8-9b42-08e7c4231689"
  },
  "status": "SUBMITTED",
  "template": {
    "id": "c8643d4d-f9f8-4484-b9c2-d0f3432e295f",
    "name": "Legal Checks",
    "version": 1,
    "status": "PUBLISHED",
    "assetType": {
      "id": "0b781899-3dd2-4746-bc98-65daef8f1efa"
    }
  },
  "owner": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assignees": [
    {
      "type": "USER",
      "id": "d615a9fe-8d8c-4287-80aa-5b058519ca45"
    },
    {
      "type": "GROUP",
      "id": "387b34f5-eac8-467c-89b6-5ee7c2e7368b"
    }
  ],
  "content": [
    {
      "id": "legalBasisSpecified",
      "name": "Are all legal bases specified?",
      "answer": {
        "type": "BOOLEAN",
        "value": true
      },
      "comment": "We use Legitimate interest as the legal basis."
    }
  ],
  "createdOn": "2023-07-10T15:03:10.433Z",
  "createdBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "lastModifiedOn": "2023-07-10T18:43:10.433Z",
  "lastModifiedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "submittedOn": "2023-07-10T18:43:10.433Z",
  "submittedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assessmentReview": {
    "id": "b50c1532-4f84-4551-bfc8-a123845fedf5"
  }
}

List assessments

get

Returns a list of assessments that you created; and the assessments that you are permitted to view. The assessments are sorted by lastModifiedOn in descending order, with the most recent first.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Query parameters

namestringOptional

The name of the assessment.

The value is case-insensitive and it returns results that contain this value.

statusstringOptional

The status of the assessment.

Possible values are: DRAFT, SUBMITTED or OBSOLETE. The value is case-insensitive. An invalid value results in an error response.

lastModifiedFromstring · date-timeOptional

The date and time that defines the start of the period when the assessment was last updated, including this timestamp.

Example: 2023-07-10T15:03:10.433Z

lastModifiedTostring · date-timeOptional

The date and time that defines the end of the period when the assessment was last updated, excluding this timestamp.

Example: 2023-07-10T15:03:10.433Z

templateIdstring · uuidOptional

The ID of the template.

templateVersionstringOptional

The version of the template. To be used in conjunction with the templateId parameter to filter assessments by a specific template and its version.

If you specify this parameter, you must also specify the templateId parameter. Use LATEST to retrieve assessments that are on the latest version of a particular templateId. For other values, it returns results that have an exact match.

assetIdstring · uuidOptional

The ID of the asset for which the assessment is conducted.

limitinteger · min: 1 · max: 50Optional

The maximum number of resources to retrieve.

If not set, the default limit of 10 is be used. The maximum value for this parameter is 50.

Default: 10

cursorstringOptional

The cursor pointing to the first resource to be included in the response. This cursor cannot be created and must have been extracted from a response returned by a previous API call.

If this parameter is missing, the API returns the resources starting from the first available resource, at index 0.

Responses

200

Example of a response for listing assessments.

application/json

A page object containing assessments.

nextCursorstringOptional

The cursor pointing to the next page. If the cursor is missing, there are no additional pages of resources available after the current one.

Example: Y3Vyc29yV2hlblRoZXJlSXNNb3JlRGF0YQo

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

There was an error processing the request.

application/json

get/assessments

HTTPcURLJavaScriptPython

GET /rest/assessments/v2/assessments HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "results": []
}

Create an assessment

post

Creates a new assessment based on the specified template.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Body

application/json

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.

statusstringOptional

The status of an assessment. Possible values are: DRAFT, SUBMITTED or OBSOLETE.

namestringOptional

The name of the assessment.

Example: Legal Checks

isVisibleToEveryonebooleanOptional

Determines whether the assessment is visible to everyone.

If set to 'false', only the Owner and Assignees will be able to access the assessment.

Example: true

contentanyOptional

A list of questions and answers for the assessment. Each question is represented by its ID and the corresponding answer.

Example: [{"id":"legalBasisSpecified","answer":{"type":"BOOLEAN","value":true}}]

Responses

201

Example of a response for creating an assessment.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

There was an error processing the request.

application/json

post/assessments

HTTPcURLJavaScriptPython

POST /rest/assessments/v2/assessments HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 499

{
  "template": {
    "id": "002c7cac-92d0-451e-b979-8ef0857a34b4"
  },
  "name": "If an asset is provided, this name is replaced by the asset's name in Collibra",
  "asset": {
    "id": "9e6ba6fa-ae24-41c8-9b42-08e7c4231689"
  },
  "owner": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assignees": [
    {
      "type": "USER",
      "id": "d615a9fe-8d8c-4287-80aa-5b058519ca45"
    },
    {
      "type": "GROUP",
      "id": "387b34f5-eac8-467c-89b6-5ee7c2e7368b"
    }
  ],
  "isVisibleToEveryone": false,
  "content": [
    {
      "id": "legalBasisSpecified",
      "answer": {
        "type": "BOOLEAN",
        "value": true
      }
    }
  ]
}

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "asset": {
    "id": "9e6ba6fa-ae24-41c8-9b42-08e7c4231689"
  },
  "status": "DRAFT",
  "template": {
    "id": "002c7cac-92d0-451e-b979-8ef0857a34b4",
    "name": "Audit Checks",
    "version": 1,
    "status": "PUBLISHED",
    "assetType": {
      "id": "0b781899-3dd2-4746-bc98-65daef8f1efa"
    }
  },
  "owner": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assignees": [
    {
      "type": "USER",
      "id": "d615a9fe-8d8c-4287-80aa-5b058519ca45"
    },
    {
      "type": "GROUP",
      "id": "387b34f5-eac8-467c-89b6-5ee7c2e7368b"
    }
  ],
  "content": [
    {
      "id": "legalBasisSpecified",
      "name": "Are all legal bases specified?",
      "answer": {
        "type": "BOOLEAN",
        "value": true
      }
    }
  ],
  "createdOn": "2023-07-10T15:03:10.433Z",
  "createdBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "lastModifiedOn": "2023-07-10T18:43:10.433Z",
  "lastModifiedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  }
}

Retake an assessment

post

Retakes the assessment with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters

idstring · uuidRequired

The ID of the assessment to be retaken.

Body

application/json

A request object to retake an assessment

Responses

201

Example of a response for retaking an assessment.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

There was an error processing the request.

application/json

post/assessments/{id}/retake

HTTPcURLJavaScriptPython

POST /rest/assessments/v2/assessments/{id}/retake HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "owner": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "asset": {
    "id": "9e6ba6fa-ae24-41c8-9b42-08e7c4231689"
  }
}

{
  "id": "07ed39f5-be3b-4406-a09e-3c78a8734261",
  "originAssessment": {
    "id": "36289c9a-4dbe-42ee-97cd-68cd89ed0c69",
    "status": "SUBMITTED"
  },
  "name": "Direct Marketing",
  "asset": {
    "id": "9e6ba6fa-ae24-41c8-9b42-08e7c4231689"
  },
  "status": "SUBMITTED",
  "template": {
    "id": "c8643d4d-f9f8-4484-b9c2-d0f3432e295f",
    "name": "Legal Checks",
    "version": 1,
    "status": "PUBLISHED",
    "assetType": {
      "id": "0b781899-3dd2-4746-bc98-65daef8f1efa"
    }
  },
  "owner": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assignees": [
    {
      "type": "USER",
      "id": "d615a9fe-8d8c-4287-80aa-5b058519ca45"
    },
    {
      "type": "GROUP",
      "id": "387b34f5-eac8-467c-89b6-5ee7c2e7368b"
    }
  ],
  "content": [
    {
      "id": "legalBasisSpecified",
      "name": "Are all legal bases specified?",
      "answer": {
        "type": "BOOLEAN",
        "value": true
      },
      "comment": "We use Legitimate interest as the legal basis."
    }
  ],
  "createdOn": "2023-07-10T15:03:10.433Z",
  "createdBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "lastModifiedOn": "2023-07-10T18:43:10.433Z",
  "lastModifiedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "submittedOn": "2023-07-10T18:43:10.433Z",
  "submittedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b"
  },
  "assessmentReview": {
    "id": "b50c1532-4f84-4551-bfc8-a123845fedf5"
  }
}