---
title: "GET /preservation/IsInstalled/{workspaceId}"
method: GET
path: "/preservation/IsInstalled/{workspaceId}"
tags: ["Legal Hold Module"]
---

# GET /preservation/IsInstalled/{workspaceId}

`GET /preservation/IsInstalled/{workspaceId}`

## Request

- Base URL: `https://platform.relativity.com/Relativity.REST/api`
- URL: `https://platform.relativity.com/Relativity.REST/api/preservation/IsInstalled/{workspaceId}`
- Auth: none declared. Required headers: `x-csrf-header`
- TypeScript: <https://skmtc.dev/relativity/apis/kcura-legalhold-services-v0/docs/preservation/IsInstalled/:workspaceId/get.ts> (a function with typed inputs; its response is checked against the schema)

[Private] IPreservationManager -

## Path parameters

- `workspaceId` integer, required

## Headers

- `x-csrf-header` string, required

## Response `200`

Successful Operation

- LegalHoldApplicationInstallResponse
  - `Error` string
  - `Results` ApplicationInstallSearchItem[]
    - `ApplicationInstallID` integer
    - `ApplicationIdentifier` DisplayableObjectIdentifier
      - `Name` string
      - `ArtifactID` integer
      - `Guids` string[]
    - `WorkspaceIdentifier` DisplayableObjectIdentifier
      - `Name` string
      - `ArtifactID` integer
      - `Guids` string[]
    - `ClientIdentifier` DisplayableObjectIdentifier
      - `Name` string
      - `ArtifactID` integer
      - `Guids` string[]
    - `MatterIdentifier` DisplayableObjectIdentifier
      - `Name` string
      - `ArtifactID` integer
      - `Guids` string[]
    - `Message` string
    - `RootFolderID` integer
    - `InstallStatus` InstallStatus
      - `Code` 'Unknown' | 'Pending' | 'InProgress' | 'Failed' | 'Completed' | 'Canceled'
      - `Message` string
      - `Details` string
      - `GetDetailsAction` Action
        - `Name` string
        - `Href` string
        - `Verb` string
        - `IsAvailable` boolean
        - `Reason` string[]
      - `RetryInstallAction` Action
        - `Name` string
        - `Href` string
        - `Verb` string
        - `IsAvailable` boolean
        - `Reason` string[]
      - `CancelInstallAction` Action
        - `Name` string
        - `Href` string
        - `Verb` string
        - `IsAvailable` boolean
        - `Reason` string[]
    - `Version` string
    - `IsOutOfDate` boolean
    - `InstalledBy` DisplayableObjectIdentifier
      - `Name` string
      - `ArtifactID` integer
      - `Guids` string[]
    - `StartedOn` string, date-time, nullable
    - `CompletedOn` string, date-time, nullable
  - `Summary` InstallStatusSummary
    - `Other` integer
    - `Pending` integer
    - `InProgress` integer
    - `Failed` integer
    - `Completed` integer
    - `Canceled` integer
    - `TotalActiveInstalls` integer
    - `Total` integer
  - `CurrentStartIndex` integer
  - `ResultCount` integer
  - `TotalCount` integer
  - `FirstPage` Action
    - `Name` string
    - `Href` string
    - `Verb` string
    - `IsAvailable` boolean
    - `Reason` string[]
  - `PreviousPage` Action
    - `Name` string
    - `Href` string
    - `Verb` string
    - `IsAvailable` boolean
    - `Reason` string[]
  - `NextPage` Action
    - `Name` string
    - `Href` string
    - `Verb` string
    - `IsAvailable` boolean
    - `Reason` string[]
  - `LastPage` Action
    - `Name` string
    - `Href` string
    - `Verb` string
    - `IsAvailable` boolean
    - `Reason` string[]

---

[API](https://skmtc.dev/relativity/apis/kcura-legalhold-services-v0.md) - [All operations](https://skmtc.dev/relativity/apis/kcura-legalhold-services-v0/llms.txt) - [OpenAPI document](https://skmtc.dev/relativity/apis/kcura-legalhold-services-v0/revisions/1c94d8855326?raw)