Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
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

Path parameters

assessmentIdstring uuid required

UUID of the assessment to update primary record for

Request body

primaryRecordType'ASSETS' | 'PROCESSING_ACTIVITY' | 'VENDORS' | 'ENTITIES' | 'ASSESS_CONTROL' | 'ENGAGEMENT' required

Type of Inventory record to be updated.

primaryRecordIdsstring[] required

The unique UUIDs of the primary records

Example request

{
  "primaryRecordType": "ASSETS",
  "primaryRecordIds": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}

Response

No Content