Assessments

Create Assessment Comment

Use this API to create a new comment on an assessment question.

post/api/assessment/v3/assessments/comments

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/assessment/v3/assessments/comments
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ASSESSMENT

Request body

commentstring required

The comment text to associate with the question

assessmentIdstring uuid required

Identifier of the assessment the comment belongs to

sectionIdstring uuid required

Identifier of the section containing the question being commented on

questionIdstring uuid required

Identifier of the question the comment applies to

Example request

{
  "comment": "Please provide supporting documentation for this response.",
  "assessmentId": "550e8400-e29b-41d4-a716-446655440000",
  "sectionId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "questionId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

Response

Created

string uuid required

Changes

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