Assessments

Take actions on assessments.

Deprecated

List assessments

get

This API version is deprecated and will be removed in future releases. We recommend you to use the V2 version of this API, which is available at /rest/assessments/v2. 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, COMPLETED 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.

lastModifiedUntilstring · date-timeOptional

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

templateIdstring · uuidOptional

The ID of the template.

templateVersionstringOptional

The version of the template.

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 the assessment relates to.

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/v1/assessments HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "results": []
}

Deprecated

This API version is deprecated and will be removed in future releases. We recommend you to use the V2 version of this API, which is available at `/rest/assessments/v2`. 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, COMPLETED, or OBSOLETE.

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/v1/assessments/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "07ed39f5-be3b-4406-a09e-3c78a8734261",
  "originAssessment": {
    "id": "36289c9a-4dbe-42ee-97cd-68cd89ed0c69",
    "status": "PUBLISHED"
  },
  "name": "Direct Marketing",
  "asset": {
    "id": "9e6ba6fa-ae24-41c8-9b42-08e7c4231689",
    "name": "Direct Marketing"
  },
  "status": "SUBMITTED",
  "template": {
    "id": "c8643d4d-f9f8-4484-b9c2-d0f3432e295f",
    "name": "Legal Checks",
    "version": 1,
    "status": "PUBLISHED",
    "assetType": {
      "id": "0b781899-3dd2-4746-bc98-65daef8f1efa",
      "name": "Business Process"
    }
  },
  "owner": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b",
    "name": "Larissa Cohen"
  },
  "assignees": [
    {
      "type": "USER",
      "id": "d615a9fe-8d8c-4287-80aa-5b058519ca45",
      "name": "Nelson Grant"
    },
    {
      "type": "GROUP",
      "id": "387b34f5-eac8-467c-89b6-5ee7c2e7368b",
      "name": "Lawyers"
    }
  ],
  "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",
    "name": "Larissa Cohen"
  },
  "lastModifiedOn": "2023-07-10T18:43:10.433Z",
  "lastModifiedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b",
    "name": "Larissa Cohen"
  },
  "submittedOn": "2023-07-10T18:43:10.433Z",
  "submittedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b",
    "name": "Larissa Cohen"
  },
  "assessmentReview": {
    "id": "b50c1532-4f84-4551-bfc8-a123845fedf5",
    "name": "Legal Checks (v1) => Direct Marketing"
  }
}

Deprecated

Retrieve an assessment by assessment review ID

get

This API version is deprecated and will be removed in future releases. We recommend you to use the V2 version of this API, which is available at /rest/assessments/v2. 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, COMPLETED, or OBSOLETE.

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/byAssessmentReview/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "07ed39f5-be3b-4406-a09e-3c78a8734261",
  "originAssessment": {
    "id": "36289c9a-4dbe-42ee-97cd-68cd89ed0c69",
    "status": "PUBLISHED"
  },
  "name": "Direct Marketing",
  "asset": {
    "id": "9e6ba6fa-ae24-41c8-9b42-08e7c4231689",
    "name": "Direct Marketing"
  },
  "status": "SUBMITTED",
  "template": {
    "id": "c8643d4d-f9f8-4484-b9c2-d0f3432e295f",
    "name": "Legal Checks",
    "version": 1,
    "status": "PUBLISHED",
    "assetType": {
      "id": "0b781899-3dd2-4746-bc98-65daef8f1efa",
      "name": "Business Process"
    }
  },
  "owner": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b",
    "name": "Larissa Cohen"
  },
  "assignees": [
    {
      "type": "USER",
      "id": "d615a9fe-8d8c-4287-80aa-5b058519ca45",
      "name": "Nelson Grant"
    },
    {
      "type": "GROUP",
      "id": "387b34f5-eac8-467c-89b6-5ee7c2e7368b",
      "name": "Lawyers"
    }
  ],
  "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",
    "name": "Larissa Cohen"
  },
  "lastModifiedOn": "2023-07-10T18:43:10.433Z",
  "lastModifiedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b",
    "name": "Larissa Cohen"
  },
  "submittedOn": "2023-07-10T18:43:10.433Z",
  "submittedBy": {
    "id": "0e787414-fd78-48a0-bfdd-69411b26c65b",
    "name": "Larissa Cohen"
  },
  "assessmentReview": {
    "id": "b50c1532-4f84-4551-bfc8-a123845fedf5",
    "name": "Legal Checks (v1) => Direct Marketing"
  }
}

Deprecated

Conduct an assessment

post

This API version is deprecated and will be removed in future releases. We recommend you to use the V2 version of this API, which is available at /rest/assessments/v2. Starts conducting an assessment by creating it in DRAFT status.

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 used as owner of the assessment.

namestringOptional

The name of the assessment.

Example: Legal Checks

isVisibleToEveryonebooleanOptional

Whether the assessment is visible to Everyone in Collibra?

Default: falseExample: true

Responses

201

Example of a response for conducting 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/conduct

HTTPcURLJavaScriptPython

POST /rest/assessments/v1/assessments/conduct HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 417

{
  "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
}

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