Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Assessments

Get List of Linked Assessments

Use this API to retrieve a list of all assessments linked to a particular record. The linked assessments list will support all copied, reassessed, and rule triggered related assessments.

🗒 Things to Know

  • The following APIs can be used to retrieve the record ID (id):

  • For Assets, Processing Activities, & Entities, use the Get List of Inventories API.

  • For Vendors, use the List Vendors API.

  • For Engagements, use the Get List of Engagements API.

  • For Incidents, use the List Incidents API.

  • For Control Implementations, use the List Controls API.

  • If the ID does not match the entered reference-object from the URL, 0 results will be returned.

get/api/assessment/v2/assessments/reference-objects/{id}/assessments

Path parameters

idstring uuid required

UUID of the reference object

Query parameters

referenceType'INVENTORY' | 'CONTROL_IMPLEMENTATION' | 'ENGAGEMENT' | 'INCIDENT' | 'CUSTOM_ENTITY' | 'DYNAMIC' required

Type of reference object

linkTypesstring[]

Types of links to filter by

pageinteger

Results page to be retrieved (0..N)

sizeinteger

Number of records per page (1…N)

sort'number,asc' | 'number,desc' | 'status,asc' | 'status,desc' | 'createdDate,asc' | 'createdDate,desc' | 'name,asc' | 'name,desc' | 'result,asc' | 'result,desc' | 'orgGroupName,asc' | 'orgGroupName,desc' | 'deadline,asc' | 'deadline,desc' | 'openRiskCount,asc' | 'openRiskCount,desc' | 'openInfoRequestCount,asc' | 'openInfoRequestCount,desc'

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

OK

emptyboolean

Flag to check if the result list is empty or not

firstboolean

Flag to check if this is the first page

lastboolean

Flag to check if this is the last page

numberinteger

Current page number (0-based)

numberOfElementsinteger

Number of elements in the current page

sizeinteger

Page size

totalElementsinteger

Total number of elements across all pages

totalPagesinteger

Total number of pages

pageableobject

Pagination information with page number (0-based, min: 0) and page size (min: 1)

Example response

{
  "content": [
    {
      "assessmentId": "550e8400-e29b-41d4-a716-446655440000",
      "assessmentName": "Privacy Impact Assessment - Customer Portal",
      "assessmentNumber": 12345,
      "templateName": "PIA Template",
      "status": "IN_PROGRESS"
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 20,
  "number": 0,
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "empty": false
}