Skip to content
Get started

Uncancel a study

client.viewer.studies.uncancel(StudyUncancelParams { studyId, studyInstanceUid } body?, RequestOptionsoptions?): StudyUncancelResponse { success, message }
post/v1/viewer/studies/uncancel

Restores a cancelled study to active status. The study must have been previously cancelled. Can be identified by either study ID or DICOM Study Instance UID.

ParametersExpand Collapse
body: StudyUncancelParams { 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
StudyUncancelResponse { success, message }

Response for uncancelling a study in Viewer

success: boolean
message?: string
Uncancel 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.uncancel();

console.log(response.success);
{
  "success": true,
  "message": "message"
}
Returns Examples
{
  "success": true,
  "message": "message"
}