Cancel a study

client.viewer.studies.cancel(?, ?): StudyCancelResponse { success, message }

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

body: StudyCancelParams { studyId, studyInstanceUid }

studyId?: string

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

studyInstanceUid?: string

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

StudyCancelResponse { success, message }

Response for cancelling a study in Viewer

success: boolean

message?: string

Cancel a study

import Avara from 'avara';

const client = new Avara({
  apiKey: process.env['AVARA_API_KEY'], // This is the default and can be omitted
});

const response = await client.viewer.studies.cancel();

console.log(response.success);

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

Returns Examples

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