ONonetrust
Assessment Management

Set Primary Record

Use this API to edit the existing primary record or set a new primary record on an assessment. For the given assessmentId, the existing primary record will either be updated or a new primary record will be created using the attributes in the API request body.

🗒 Things to Know

  • If the template has a question with the primary record enabled, then the primary record is set as the response to that question and the related attributes and inventory questions will be pre-populated.

  • The primary record can be edited for Inventory and Assess Control primary record types.

  • The primary record list cannot be greater than 1 for Inventory primary record types.

  • The primary record list can be greater than 1 for Assess Control primary record types.

put/api/assessment/v2/assessments/{assessmentId}/primary-records

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/assessment/v2/assessments/{assessmentId}/primary-records
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ASSESSMENT

Path parameters

assessmentIdstring uuid required

UUID of the assessment to update primary record for

Request body

primaryRecordTypestring required

type of record to be updated. Standard values are ASSETS, PROCESSING_ACTIVITY, VENDORS, ENTITIES, ASSESS_CONTROL, ENGAGEMENT. Custom entity types such as MODELS, AISYSTEMS, AIAGENTS, DATASETS, PROJECTS are also accepted.

primaryRecordIdsstring[]

Example request

{
  "primaryRecordType": "ASSETS"
}

Response

No Content

Changes

No recorded changes to this operation across all 1 revision of this API.