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.

Path Params
uuid
required

UUID of the assessment to update primary record for

Body Params
string
required
length ≥ 1

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.

primaryRecordIds
array of uuids, unique
length ≥ 1
primaryRecordIds
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Choose an example:
*/*