myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
  1. Privacy Automation - Assessment Automation
  2. Assessments

Search Assessments

post
https://{hostname}/api/assessment/v2/assessments/search

Use this API to search assessments across the tenant based on template type and filter criteria. The response returns a list of matching assessments up to the specified limit, along with totalCount and hasMore values to indicate whether additional assessments are available.

Query Params
templateTypes
array of strings
required

List of template types to filter assessments by.

templateTypes*
string

Free-text search applied across assessment name and number.

int32
1 to 100
Defaults to 20

Maximum number of assessments to return. Defaults to 20 and is capped at 100 regardless of the value supplied.

sort
array of strings
Defaults to createdDate,desc

Repeat the sort query parameter for multiple criteria in property,asc|desc format. Defaults to createdDate,desc.

sort
Body Params
filterCriteria
array of objects

Criteria to filter the assessment list by. Each item filters on one field.

filterCriteria
string
enum

View type to load assessments for. Ignored by the linked assessments endpoint, which derives it from entityTypeReference. Defaults to ASSESSMENT_AUTOMATION_LIST_VIEW on the search endpoint.

visibleColumns
array of strings

Column names to include in the response. Omit or send an empty list to use the default set of columns.

visibleColumns
boolean

Loads the admin view. Used by the search endpoint only.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated about 20 hours ago

Did this page help you?
Language
Credentials
OAuth2
Missing 2 required scopes
URL
LoadingLoading…
Response
Choose an example:
application/json
*/*

Updated about 20 hours ago

Did this page help you?