Skip to main content
GET
Get the summary for an assessment

Path Parameters

id
integer<int64>
required

Query Parameters

format
enum<string>
default:html

The format to render the summary in

Available options:
html,
markdown

Response

200 - application/json

OK

id
integer<int64>

The assessment's identifier

summary
string

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

version
string

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.

edited
boolean

Whether the summary has been edited since it was generated