Cancel a study

StudyCancelResponse Viewer.Studies.Cancel(, )

POST/v1/viewer/studies/cancel

Marks a study as cancelled. Cancelled studies are preserved but flagged as inactive. Can be identified by either study ID or DICOM Study Instance UID.

ParametersExpand Collapse

StudyCancelParams parameters

string studyID

Unique study identifier. Format: stu_{32-hex-chars}

string studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1

ReturnsExpand Collapse

class StudyCancelResponse:

Response for cancelling a study in Viewer

required Boolean Success

string Message

Cancel a study

StudyCancelParams parameters = new();

var response = await client.Viewer.Studies.Cancel(parameters);

Console.WriteLine(response);

{
  "success": true,
  "message": "message"
}

Returns Examples

{
  "success": true,
  "message": "message"
}