## Retrieve By Uid

`StudyRetrieveByUidResponse viewer().studies().retrieveByUid(StudyRetrieveByUidParamsparams = StudyRetrieveByUidParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**get** `/v1/viewer/studies/by-uid/{studyInstanceUid}`

Retrieves a single study by its DICOM Study Instance UID. This is useful when you have the DICOM UID but not the Avara study ID.

### Parameters

- `StudyRetrieveByUidParams params`

  - `Optional<String> studyInstanceUid`

    DICOM Study Instance UID. Format: numbers and dots (e.g., 1.2.840.10008.5.1.4.1.1.2).

### Returns

- `class StudyRetrieveByUidResponse:`

  A study entity in the Viewer system with viewing status

  - `Optional<LocalDateTime> cancelledAt`

    Timestamp when the study was cancelled, null if not cancelled

  - `Optional<LocalDateTime> createdAt`

    Timestamp when the study was created

  - `boolean isCancelled`

    Whether the study has been cancelled

  - `Severity severity`

    Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

    - `NORMAL("normal")`

    - `HIGH("high")`

    - `STAT("stat")`

  - `String studyDescription`

    Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT')

  - `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')

  - `StudyViewerStatus studyViewerStatus`

    - `INCOMPLETE("incomplete")`

    - `COMPLETE("complete")`

  - `Optional<LocalDateTime> updatedAt`

    Timestamp when the study was last updated

  - `Optional<UserReference> assignedTo`

    A reference to a user with basic identifying information

    - `String email`

      User's email address

    - `String userId`

      Unique user identifier. Format: usr_{32-hex-chars}

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<ApiKeyReference> createdByApiKey`

    A reference to an API key with basic identifying information

    - `String apiKeyId`

      Unique API key identifier (UUIDv4 format)

    - `String description`

      Human-readable description of the API key

    - `Optional<Boolean> isViewerEnabled`

      Whether this API key has access to the Viewer product

  - `Optional<UserReference> createdByUser`

    A reference to a user with basic identifying information

    - `String email`

      User's email address

    - `String userId`

      Unique user identifier. Format: usr_{32-hex-chars}

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<ExpressCustomerReference> expressCustomer`

    A reference to an Express customer with basic identifying information

    - `String expressCustomerId`

      Unique Express customer identifier. Format: cus_{32-hex-chars}

    - `String expressCustomerName`

      Name of the Express customer

  - `Optional<Metadata> metadata`

    Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

### Example

```java
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.viewer.studies.StudyRetrieveByUidParams;
import com.avara.models.viewer.studies.StudyRetrieveByUidResponse;

public final class Main {
    private Main() {}

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

        StudyRetrieveByUidResponse response = client.viewer().studies().retrieveByUid("1.2.840.10008.5.1.4.1.1.2");
    }
}
```