Skip to content
Avara
Get started
API Reference
Viewer

Studies

Create a new study
client.viewer.studies.create(StudyCreateParams { severity, studyDescription, studyInstanceUid, 3 more } body, RequestOptionsoptions?): StudyCreateResponse { cancelledAt, createdAt, isCancelled, 11 more }
post/v1/viewer/studies
List studies with pagination
client.viewer.studies.list(StudyListParams { assignedTo, cursor, isCancelled, 4 more } query?, RequestOptionsoptions?): CursorStudies<StudyListResponse { cancelledAt, createdAt, isCancelled, 11 more } >
get/v1/viewer/studies
Retrieve a study by ID
client.viewer.studies.retrieve(stringstudyID, RequestOptionsoptions?): StudyRetrieveResponse { cancelledAt, createdAt, isCancelled, 11 more }
get/v1/viewer/studies/{studyId}
Update a study
client.viewer.studies.update(stringstudyID, StudyUpdateParams { assignedTo, metadata, severity, 2 more } body?, RequestOptionsoptions?): StudyUpdateResponse { cancelledAt, createdAt, isCancelled, 11 more }
patch/v1/viewer/studies/{studyId}
Cancel a study
client.viewer.studies.cancel(StudyCancelParams { studyId, studyInstanceUid } body?, RequestOptionsoptions?): StudyCancelResponse { success, message }
post/v1/viewer/studies/cancel
Uncancel a study
client.viewer.studies.uncancel(StudyUncancelParams { studyId, studyInstanceUid } body?, RequestOptionsoptions?): StudyUncancelResponse { success, message }
post/v1/viewer/studies/uncancel
Generate a viewer reroute URL
client.viewer.studies.rerouteURL(StudyRerouteURLParams { studyId, studyInstanceUid } body?, RequestOptionsoptions?): StudyRerouteURLResponse { url }
post/v1/viewer/studies/reroute-url
Retrieve a study by DICOM UID
client.viewer.studies.retrieveByUid(stringstudyInstanceUid, RequestOptionsoptions?): StudyRetrieveByUidResponse { cancelledAt, createdAt, isCancelled, 11 more }
get/v1/viewer/studies/by-uid/{studyInstanceUid}