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
enum
required

Type of Inventory record to be updated.

Allowed:
primaryRecordIds
array of uuids
required
length β‰₯ 1

The unique UUIDs of the primary records

primaryRecordIds*
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 2 required scopes
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*