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 params

Optional<String> studyId

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

Optional<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

boolean success

Optional<String> message

Cancel a study

package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.viewer.studies.StudyCancelParams;
import com.avara.models.viewer.studies.StudyCancelResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyCancelResponse response = client.viewer().studies().cancel();
    }
}

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

Returns Examples

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