VIvisotrust
client-api-assessment-rest-resource

Get the summary for an assessment

Returns the assessment summary as the stored HTML report by default. If the summary has been edited, the edit is returned.

Pass format=markdown to get the same content as Markdown instead — headings, lists and tables are preserved, but the markup and styling are not, so the summary can be read as text or fed to another system without stripping HTML first.

get/api/v1/assessments/{id}/summary

Request

Path parameters

idinteger required

Query parameters

format'html' | 'markdown'

The format to render the summary in

Response

OK

idinteger

The assessment's identifier

summarystring

The assessment summary, as HTML by default or as Markdown when 'format=markdown' is requested

versionstring

Identifies this revision of the summary. Pass it back when updating the summary to have the update rejected if the summary has changed in the meantime.

editedboolean

Whether the summary has been edited since it was generated

Changes

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