Help Page Home

POST api/assessments/{id}/images

Post a new image to a specific assessment.

Required Scopes

Assessment.ImageAdmin

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The unique ID for the assessment.

globally unique identifier

Required

Body Parameters

Image data to be posted.

ImageData
NameDescriptionTypeAdditional information
DisplayOrder

integer

None.

JPEGData

Collection of byte

None.

Request Formats

{
  "DisplayOrder": 1,
  "JPEGData": "QEA="
}
<ImageData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models">
  <DisplayOrder>1</DisplayOrder>
  <JPEGData>QEA=</JPEGData>
</ImageData>

Response Information

Resource Description

ImageHeader
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

CreatedDate

date

None.

DisplayOrder

integer

None.

SequenceNumber

integer

None.

Comments

string

None.

Response Formats

{
  "Id": "e02f1a68-aa4d-4590-9d5c-80ef92e34291",
  "CreatedDate": "2026-09-30T20:05:42.5239896+01:00",
  "DisplayOrder": 1,
  "SequenceNumber": 1,
  "Comments": "sample string 2"
}
<ImageHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models">
  <Comments>sample string 2</Comments>
  <CreatedDate>2026-09-30T20:05:42.5239896+01:00</CreatedDate>
  <DisplayOrder>1</DisplayOrder>
  <Id>e02f1a68-aa4d-4590-9d5c-80ef92e34291</Id>
  <SequenceNumber>1</SequenceNumber>
</ImageHeader>