# Relativity aiR Developer Documentation

> This site contains developer and API documentation for Relativity aiR, a Legal Data Intelligence and e-discovery platform hosted in the cloud. This site contains code samples, tutorials and API references for developers who extend or integrate with Relativity aiR. This content helps developers understand how to extend or integrate with Relativity aiR.

## Core Pages
- [Homepage](https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/index.htm): Main entry point.

### Analytics Conceptual
- [Analytics Conceptual] (https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual.htm): Find the .NET and REST API content, version history, and supported version ranges for the Analytics Conceptual business domain.
  - Headings: H1: Analytics Conceptual | H2: Current Analytics Conceptual API content | H2: Version History

- [Analytics Conceptual Index (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index__.NET_.htm): Use the .NET Analytics Conceptual Index API to create, manage, and run jobs on conceptual indexes that use Latent Semantic Indexing in Relativity Analytics.
  - Second paragraph: The Analytics Conceptual Index API supports programmatically managing conceptual indexes in Relativity Analytics. It includes the following features:
  - Headings: H1: Analytics Conceptual Index (.NET) | H2: Fundamentals for the Conceptual Index API | H2: Guidelines for using the Conceptual Index API | H3: Common workflows | H3: Catch exceptions | H3: Execute valid operations for the index state | H3: Index states and job validation | H3: Monitor the analysis progress | H2: Create a conceptual index | H2: Retrieve a conceptual index | H2: Update a conceptual index | H2: Delete a conceptual index | H2: Helper methods for conceptual index jobs | H3: Submit a conceptual index job | H3: Retrieve the status of a job | H3: Cancel a job

- [Analytics Conceptual Index (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index__REST_.htm): Use the REST Analytics Conceptual Index service to create, manage, and run jobs on conceptual indexes that use Latent Semantic Indexing in Relativity Analytics.
  - Second paragraph: The Analytics Conceptual Index service supports programmatically managing conceptual indexes in Relativity Analytics. It includes the following features:
  - Headings: H1: Analytics Conceptual Index (REST) | H2: Guidelines for using the Conceptual Index service | H3: URLs | H2: Postman sample file | H2: Create a conceptual index | H2: Retrieve a conceptual index | H2: Update a conceptual index | H2: Delete a conceptual index | H2: Helper endpoints for conceptual index jobs | H3: Submit a conceptual index job | H3: Retrieve the status of a job | H2: Cancel a job

- [Analytics Conceptual Index .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/AnalyticsConceptualIndexNETAPI.html): Analytics Conceptual Index .NET API Reference

- [Analytics Conceptual Index .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index_NET_API_Reference.htm): Relativity.Analytics.Conceptual.SDK Reference
  - Headings: H1: Analytics Conceptual Index .NET API Reference | H2: Relativity.Analytics.Conceptual.SDK

- [Analytics Conceptual Index REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index_REST_API_Reference.htm): conceptual-analytics Reference
  - Headings: H1: Analytics Conceptual Index REST API Reference | H2: conceptual-analytics

- [Analytics Conceptual Index REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/AnalyticsConceptualIndexRESTAPI.html): Analytics Conceptual Index REST Reference


### Application
- [Application SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Application/ApplicationNETAPI.html): Application SDK .NET API Reference

- [Application SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Application/Application_NET_API_Reference.htm): Browse the .NET API reference for the Application business domain, provided in the Relativity.Application.SDK.
  - Headings: H1: Application SDK .NET API Reference | H2: Relativity.Application.SDK


### ARM
- [ARM .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARMNETAPI.html): ARM .NET API Reference

- [ARM .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_NET_API_Reference.htm): Relativity.ARM.SDK Reference
  - Headings: H1: ARM .NET API Reference | H2: Relativity.ARM.SDK

- [ARM API (REST) V1 to V3 migration guide - part 1] (https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_API_V3_migration_guide.htm): Migrate from the deprecated ARM V1 API to V3, including breaking changes such as string job IDs, new response objects, and the NotifyJobRunner option.
  - Second paragraph: This is the first part of the migration guide. For the second part covering other endpoints, see ARM API (REST) V1 to V3 migration guide - part 2.
  - Headings: H1: ARM API (REST) V1 to V3 migration guide - part 1 | H2: Breaking changes | H3: Job ID type change | H3: Response model changes | H3: NotificationOptions structure | H3: MigratorOptions structure | H3: V1 MigratorOptions boolean flags to V3 ExcludedMigrators mapping | H3: Restore job DestinationOptions properties removed | H3: Migrator-specific configuration options | H2: Feature availability matrix | H2: Migration paths | H3: Archive jobs | H3: Restore jobs | H3: Job actions | H3: Features without a migration path | H2: Part 1 migration checklist | H2: Additional resources | H2: Getting help

- [ARM API (REST) V1 to V3 migration guide - part 2] (https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_API_V3_migration_guide_part_2.htm): Migrate the ARM job list, status, statistics, available archives, and archive directories endpoints from earlier versions to the V3 REST API.
  - Second paragraph: This is the second part of the migration guide. For the first part covering breaking changes and other endpoints, see ARM API (REST) V1 to V3 migration guide - part 1.
  - Headings: H1: ARM API (REST) V1 to V3 migration guide - part 2 | H2: List Jobs | H3: Old approach | H3: New endpoint | H3: Request body | H3: Response | H3: JobState values | H3: JobType values | H3: Fields | H3: Pagination | H3: What changed | H3: What you must do | H2: Job Status | H3: Old approach | H3: New endpoint | H3: Response | H3: Fields | H3: Phase and Stage model | H3: CurrentPhase fields | H3: What changed versus legacy SQL | H3: What you must do | H2: Job Statistics | H3: Old approach | H3: New endpoint | H3: Response | H3: Migrators entry fields | H3: What changed versus V1 private | H3: Error responses | H3: What you must do | H2: Available Archives for Restore | H3: Old approach | H3: New endpoint | H3: Request body | H3: Response shape | H3: What you must do | H2: Archive Storage Path Directories | H3: Old approach | H3: New endpoint | H3: Response shape | H3: What you must do | H2: Error responses (all endpoints) | H2: Part 2 migration checklist | H2: Additional resources | H2: Getting help

- [ARM Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM.htm): Find the V1 and V3 ARM API content, migration guides, version history, and supported version ranges for the ARM business domain.
  - Second paragraph: For instructions, see the migration guides:
  - Headings: H1: ARM | H2: V3 ARM API content

- [ARM REST API Reference V3] (https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARMRESTAPI_V3.html): ARM API REST Reference

- [ARM REST API Reference V3] (https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_REST_API_Reference_V3.htm): Browse the REST API reference for the ARM V3 service, Relativity.ARM.Services.Interfaces V3.
  - Headings: H1: ARM REST API Reference V3 | H2: Relativity.ARM.Services.Interfaces V3


### Audit
- [Audit (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_APIs.htm): Use the .NET Audit APIs to revert, retrieve, and search instance-level and workspace-level audit records stored in Elasticsearch.
  - Second paragraph: These APIs don't support working with audit records stored in an SQL Server database.
  - Headings: H1: Audit (.NET) | H2: Fundamentals for Audit APIs | H3: Audit Revert API | H3: Audit Pivot  API | H3: Reviewer Statistics  API | H3: Audit Query  API | H3: Audit Object Manager UI  API | H2: Guidelines for the Audit APIs | H3: Operations supported by the Audit APIs | H3: Admin-level context | H3: Query conditions | H2: Audit Revert API | H3: Validate a revert operation for an audit | H3: Revert an audit | H3: Mass revert a list of audits | H2: Audit Pivot API | H3: Query with Pivot on audit data | H2: Reviewer Statistics API | H3: Retrieve action counts for updated documents | H3: Retrieve the usage time per reviewer | H3: Retrieve extracted text size of reviewed documents | H3: Retrieve an aggregate of user actions by hour | H3: Retrieve choices reviewed by users | H3: Retrieve a summary report of reviewer statistics | H2: Audit Query API | H3: Query for an audit record | H2: Audit Object Manager UI API | H3: Query on audit fields | H3: Query on audit fields and return a smaller payload

- [Audit (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_services_in_REST.htm): Use the REST Audit services to revert, retrieve, and search instance-level and workspace-level audit records stored in Elasticsearch.
  - Second paragraph: These APIs don't support working with audit records stored in an SQL Server database.
  - Headings: H1: Audit (REST) | H2: Guidelines for Audit services | H3: URLs | H3: Operations supported by the Audit services | H3: Query conditions | H2: Audit Revert service | H3: Validate a revert operation for an audit action | H3: Revert an audit | H3: Mass revert a list of audits | H2: Audit Pivot service | H3: Query with Pivot on audit data | H2: Reviewer Statistics service | H3: Retrieve action counts for updated documents | H3: Retrieve the usage time per reviewer | H3: Retrieve size of the extracted text for reviewed documents | H3: Retrieve an aggregation of user actions by hour | H3: Retrieve choices reviewed by users | H3: Retrieve a summary report of reviewer statistics | H2: Audit Query service | H3: Query for an audit record | H2: Audit Object Manager UI service | H3: Query endpoint | H3: Query on audit fields and return a smaller payload

- [Audit .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Audit/AuditNETAPI.html): Audit .NET API Reference

- [Audit .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_NET_API_Reference.htm): Relativity.Audit.SDK Reference
  - Headings: H1: Audit .NET API Reference | H2: Relativity.Audit.SDK

- [Audit Business Domain] (https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit.htm): Find the .NET and REST Audit API content, version history, and supported Relativity and Audit RAP version ranges for the Audit business domain.
  - Headings: H1: Audit | H2: Current Audit API content | H2: Version History

- [Audit REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_REST_API_Reference.htm): relativity-audit Reference
  - Headings: H1: Audit REST API Reference | H2: relativity-audit

- [Audit REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Audit/AuditRESTAPI.html): [API NAME] REST Reference


### Automated Workflows
- [Automated Workflow .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/AutomatedWorkflowNETAPI.html): Automated Workflow .NET API Reference

- [Automated Workflows] (https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows.htm): Learn the fundamentals of automated workflows, including trigger types, actions, and statuses, and find how to register and send them through the API and service.
  - Second paragraph: Common use cases:
  - Headings: H1: Automated workflows | H2: Fundamentals of automated workflows | H3: Troubleshooting information | H2: Automated Workflows API content | H2: Version History

- [Automated Workflows (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_API.htm): Use the .NET AutomatedWorkflowsManager to programmatically register actions, register triggers, and send triggers for automated workflows.
  - Second paragraph: You can also interact with the Automated Workflows API through the REST API. See Automated Workflows service.
  - Headings: H1: Automated Workflows (.NET) | H2: Working with the Automated Workflows API | H3: Instantiating the Automated Workflows Manager | H3: Using the SDK on a Kepler Service | H3: Using the SDK on an Event Handler | H3: Registering your Trigger | H2: Registering your action | H3: Long Running RPC | H3: Registering your Action | H3: Action Definition Variables | H3: Registering your action with a dynamic rule | H2: Versioning your trigger or action | H3: Updating workflows to use the latest version of a trigger/action | H2: Sending a trigger/triggering workflows that use your trigger | H2: Validating your workflow | H2: Code samples | H3: Register a trigger | H3: Register an action | H3: Send a trigger | H3: Deleting a trigger | H3: Deleting an action

- [Automated Workflows (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_service.htm): Use the Automated Workflows REST service to register actions, register triggers, and send triggers, including optional CID authorization for HTTP steps.
  - Second paragraph: You can find the REST Service reference documentation and download the OAS specification file in this topic.  You can also interact with automated workflows through the .NET API. See Automated Workflows API.
  - Headings: H1: Automated Workflows (REST) | H3: URLs | H3: CID authorization (resource and scopes) | H3: Methods | H2: Examples | H3: Create a client in .NET to interact with the REST Service | H3: List Triggers | H3: Create or Update a Trigger | H3: Delete a Trigger | H3: List Actions | H3: Create or Update an Action | H3: Create or Update an Action with Dynamic Rule | H3: Delete Action | H3: Send Trigger/Notify Event | H3: Validate Workflow

- [Automated Workflows .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_NET_API_Reference.htm): Browse the .NET API reference for Automated Workflows, provided in the Relativity.AutomatedWorkflows.SDK.
  - Headings: H1: Automated Workflows .NET API Reference | H2: Relativity.AutomatedWorkflows.SDK

- [Automated Workflows API REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/AutomatedWorkflowRESTAPI.html): Automated Workflows REST API Reference

- [Automated Workflows REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_REST_API_Reference.htm): Browse the REST API reference for the relativity-automated-workflows service.
  - Headings: H1: Automated Workflows REST API Reference | H2: relativity-automated-workflows


### Background processing
- [Agent Resiliency Guidelines] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/Agent_resiliency_guidelines.htm): Add retry logic and detailed logging to agents running on the Relativity aiR Compute platform, using a Polly 5.7.0 retry pattern to handle transient connectivity errors.
  - Second paragraph: The following examples use the Polly 5.7.0 package. The Relativity agent framework supports Polly version 5.7.0 only. Do not add this assembly to your application; Polly.dll is available for use by default.
  - Headings: H1: Agent Resiliency Guidelines | H2: Example retry pattern | H2: Shut down the agent

- [Agent Scaling Guidelines] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/Scaling_guidelines_for_Agents.htm): Use a Workload Discovery endpoint to dynamically scale the number of concurrent agent processes in Relativity aiR, and see which agents benefit from scaling.
  - Second paragraph: You can dynamically set the number of concurrently running agent processes based on workload of an agent at any given time. The default number of processes is one. Each agent process is given 1 vCPU and 1 GB of RAM. This is not customizable. You can horizontally scale by defining a Workload Discovery endpoint that provides visibility into the current workload size of an agent.
  - Headings: H1: Agent Scaling Guidelines | H2: Scaling fundamentals | H2: Scaling use cases | H2: Get started with scaling | H3: Creating the Workload Discovery endpoint | H3: Associate the Workload Discovery endpoint with an agent | H2: Workload discovery best practices

- [Agent Status Manager .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/AgentStatusManagerNETAPI.html): Agent Status Manager .NET API Reference

- [Agent Status Manager .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/Agent_Status_Manager_NET_API_Reference.htm): Browse the .NET API reference for the Agent Status Manager, provided in the Relativity.HostingBridge.SDK.
  - Headings: H1: Agent Status Manager .NET API Reference | H2: Relativity.HostingBridge.SDK

- [Agent Workload Discovery .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/Agent_WorkloadDiscovery_NET_API_Reference.htm): Browse the .NET API reference for Agent Workload Discovery, provided in the Relativity.Platform.Agent.WorkloadDiscovery.SDK.
  - Headings: H1: Agent Workload Discovery .NET API Reference | H2: Relativity.Platform.Agent.WorkloadDiscovery.SDK

- [Agent Workload Discovery .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/AgentWorkloadDiscoveryNETAPI.html): Agent Workload Discovery .NET API Reference

- [Basic concepts for agents] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/Basic_concepts_for_agents.htm): Review these basic concepts to learn more about the common implementation tasks, uploading agents to Relativity, logging events, and other features of custom agent functionality.
  - Second paragraph: Complete these common implementation tasks when developing custom agents. You can also use a template to create an agent. For more information, see Visual Studio templates for Relativity.
  - Headings: H1: Basic concepts for agents | H2: Common implementation tasks for agents | H2: Establish a database connection from an agent | H2: Connect to the Services API with the client-side proxy | H2: Upload agents to Relativity | H3: Add an assembly containing an agent | H2: Remove agents from Relativity | H3: Remove one agent from an application | H3: Remove an entire application that contains agents | H2: Agent runs | H2: Logging for agent events | H3: Logging levels

- [Best practices for agents] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/Best_practices_for_agents.htm): Use these guidelines to optimize your application development with custom agents.
  - Second paragraph: When you implement a new agent, you have the option to use a job queue table stored in the EDDS database. This approach ensures that the application and agent can share information about job statuses and errors. Implement job queue error handling, which might include displaying an error message. Disable the agent when a critical error occurs.
  - Headings: H1: Best practices for agents | H2: Optionally use a job queue | H2: Use helper classes | H2: Use a Workload discovery endpoint | H2: Avoid creating App Domains | H2: Return from the Execute method | H2: Do not expose HTTP endpoints | H2: Agents should be ephemeral and fault-tolerant | H2: Do not rely on Agent IDs | H2: Establish an appropriate execution pattern | H2: Use fully qualified domain names when accessing fileshares | H2: Do not assume fileshare is available before first operation

- [Build agents] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/Background_processing.htm): You can perform background processing in Relativity by developing custom agents. Since these agents perform background work, they don
  - Second paragraph: Additionally, you can implement agents as managers that monitor tasks or workers that perform specific jobs in your environment. You can develop custom agents to perform their background processes at configurable intervals. For example, Relativity uses agents to OCR documents.
  - Headings: H1: Agents | H2: Version History

- [Build your first agent] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/Building_your_first_agent.htm): This tutorial illustrates how to create a simple agent that raises the message Hello World! The current time is. <time>. It describes how to write the source code for this agent by adding references to your Visual Studio project, inheriting from the agent base class, overriding the Execute() method with your business logic, and performing other key development tasks. It also shows you how to add the compiled .dlls for the agent to Relativity and view the messages that the agent raises.
  - Second paragraph: Complete the following tasks to before you begin implementing an agent:
  - Headings: H1: Build your first agent | H2: Before you begin | H2: Build an agent

- [Execution patterns for agents] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/Execution_patterns_for_agents.htm): Learn how to trigger an agent
  - Second paragraph: You can't adjust the interval for an agent through the UI. The interval must be configured in the application.xml file. See Scheduled intervals.
  - Headings: H1: Execution patterns for agents | H2: Scheduled intervals | H2: On-demand | H3: Agent Status Manager (.NET) | H3: Agent Status Manager (REST)

- [Troubleshoot agents] (https://platform.relativity.com/RelativityaiR/Content/Background_processing/Troubleshooting_agents.htm): You can use the following information to remotely debug agents and to identify the causes of agent errors. For information about configuring your environment for troubleshooting, see Development environment settings.
  - Headings: H1: Troubleshoot agents


### Billing
- [Billing APIs] (https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing.htm): Find the Billing APIs for retrieving billing information, including the Billing Insights REST API and its API reference.
  - Headings: H1: Billing APIs

- [Billing Insights API (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing_Insights_API.htm): Use the read-only Billing Insights REST API to retrieve billing metrics by instance, workspace, matter, and client for your Relativity aiR tenant.
  - Second paragraph: With this API you can check billing metrics breakdowns by instance, workspace, matter, and client. Typical use-cases:
  - Headings: H1: Billing Insights API (REST) | H2: Resources | H2: Methods | H2: Authentication | H3: Bearer Token Authentication | H2: Errors | H2: Response Codes | H2: Pagination | H3: Remarks | H2: Sorting | H2: Hashing | H2: Client code generation | H2: Code Samples | H2: Version History

- [Billing Insights REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Billing/BillingInsightsRESTAPI.html): Billing Insights API REST Reference

- [Billing Insights REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Billing/BillingInsightsRESTAPIv1.html): Billing Insights API REST Reference

- [Billing Insights REST API Reference (V1)] (https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing_Insights_REST_API_Reference_V1.htm): Browse the REST API reference for version 1 of the Billing Insights API.
  - Headings: H1: Billing Insights REST API Reference (V1)

- [Billing Insights REST API Reference (V2)] (https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing_Insights_REST_API_Reference.htm): Browse the REST API reference for version 2 of the Billing Insights API, billing-insights.
  - Headings: H1: Billing Insights REST API Reference (V2) | H2: billing-insights


### Building Relativity applications
- [Advanced functionality for the application framework] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Advanced_functionality_for_the_application_framework.htm): You can further enhance your applications by learning about how to use advanced functionality, such as versioning. In addition, you can fine-tune your applications with an understanding of other advanced features.
  - Second paragraph: Relativity applications have two groups of components:
  - Headings: H1: Advanced functionality for the application framework | H2: Hosted and schema component | H3: Schema version | H2: Application schema versions | H3: Upgrades and schema versions | H2: Tab behavior during installations and upgrades | H2: Object type event handler behavior during upgrades | H2: Application resource file purge

- [Basic concepts for the application framework] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Basic_concepts_for_the_application_framework.htm): Review these basic concepts to learn more about using the Application Deployment System (ADS) as your application framework.
  - Second paragraph: Use the ADS to package the custom applications that you develop. In the Relativity UI, you can add Relativity Dynamic Objects (RDOs), fields, layouts, choices, views, tabs, and other data objects to your application. The ADS provides a framework for packaging both the objects that you develop in Relativity UI, and custom assemblies that you upload. It also includes functionality that facilitates exporting applications for deployment in other workspaces and Relativity instances. See Create an application in Relativity.
  - Headings: H1: Basic concepts for the application framework | H2: Package applications | H2: View component GUIDs

- [Best practices for building applications] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Best_practices_for_application_building.htm): Use these guidelines when developing Relativity applications through the Application Deployment System (ADS).
  - Second paragraph: Set up a dedicated or “golden” environment for developing applications. You can make all your schema changes for an application in this environment, such as adding new object types, event handlers, and other resources. When you release applications to clients, you ensure that they have the same origin signatures, and that changes to the applications import successfully.
  - Headings: H1: Best practices for building applications | H2: Set up a dedicated environment for application development | H2: Use GUIDs to reference object types | H2: Use GUIDs when developing event handlers | H2: Set the RunTarget attribute on event handlers | H2: Use Relativity API Helpers for establishing Services API connections | H2: Use the Relativity UI to edit applications | H2: Don't downgrade application versions | H2: Keep applications locked unless you're editing them | H2: Maintain application validation requirements | H2: Implement your own application components | H2: Add an About page | H2: Open and close connections | H2: Batch data | H2: Test various file types | H2: Do not include assemblies in RAP files for assemblies provided by Relativity

- [Build applications] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Building_Relativity_applications.htm): You can build applications that extend Relativity by using the Application Deployment System (ADS). ADS provides a framework for application development by helping you leverage existing functionality in Relativity, such as views, layouts, and other features. It also simplifies the packaging of custom code, which you can upload to Relativity and associate with an application that you create through the Relativity UI. When you have finished developing your application, you can easily export a RAP file for installation on other Relativity instances or in specific workspaces.
  - Second paragraph: See these related pages:
  - Headings: H1: Build applications | H2: Use the ADS | H2: Writing custom code for applications

- [Build your first Relativity application in the UI] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Building_your_first_application.htm): This tutorial familiarizes you with functionality in the Relativity UI that supports packaging multiple components in a custom application. It illustrates how to create a simple application that includes two Relativity Dynamic Objects (RDOs), which share a many-to-many relationship between them. It also shows you how to export the application as a RAP file that you can use to install the application in another workspace.
  - Second paragraph: Complete the following tasks depending on your development goals:
  - Headings: H1: Build your first Relativity application in the UI | H2: Before you begin | H2: Build a Relativity application in the UI

- [Create an application in Relativity] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Creating_an_application_in_Relativity.htm): Using the Application Deployment System (ADS), you can package components added to your custom application so that you can easily deploy it to other workspaces or Relativity instances. In the Relativity UI, you can create Relativity Dynamic Objects (RDOs), views, layouts, choices, tabs, and fields for inclusion in your application. You can also provide advanced functionality in your application by uploading custom code for event handlers, mass operations, and other features to Relativity. After you complete these steps, you create an application, and then add these components as well as your custom code.
  - Second paragraph: In the Relativity UI, you can create Relativity Dynamic Objects (RDOs), views, layouts, choices, tabs, and fields for inclusion in your application. You can also provide advanced functionality in your application by uploading custom code for event handlers, mass operations, and other features to Relativity. After you complete these steps, you can create an application, and then add these components and your custom code to it.
  - Headings: H1: Create an application in Relativity | H2: Create an application | H3: New application layout fields | H2: View or edit application details | H2: Add components to an application | H3: Associative lists | H2: Validation requirements for application components

- [Develop application event handlers] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Developing_application_event_handlers.htm): You can develop event handlers that facilitate common tasks performed when installing and uninstalling applications, as well as during workspace creation or deletion. You can use application event handlers to execute tasks that facilitate the installation of your custom application by creating database tables or setting default values on objects. They can also perform cleanup activities when you delete a workspace or uninstall an application. These event handlers execute at the application level rather than on specific object types. For more information, see Developing object type event handlers.
  - Second paragraph: The following table provides a brief description of the application type event handlers available in the Relativity platform.
  - Headings: H1: Develop application event handlers

- [Loading application resources] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Loading_application_resources.htm): Application Deployment System components – agents, custom pages, event handlers – include resource files such as application libraries (DLLs), config files, images, and stylesheets. When developing and troubleshooting Relativity applications, it is important to understand where and in what order the resources are deployed. Agents, custom pages, and event handlers, and Kepler services run in their own application domains that are spun up dynamically.
  - Second paragraph: See these related pages:
  - Headings: H1: Loading application resources | H2: Application domain directories | H3: Agents | H3: Custom pages | H3: Event handlers | H2: Loading order and priority

- [Post Install event handlers] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Post_Install_event_handlers.htm): You can develop Post Install event handlers that execute immediately after the user installs an application. You can identify the execution type of these event handlers and the order in which you want them to run. The following examples illustrate how you can use Post Install event handlers.
  - Second paragraph: You can use Post Install event handlers that run only once to avoid resetting the default values on object type instances during the upgrade of an application. The use of these event handlers prevents any updates to these instances from being overwritten. See Upgrading applications on the RelativityOne Documentation site.
  - Headings: H1: Post Install event handlers | H2: Guidelines for Post Install event handlers | H2: Code sample for a Post Install event handler

- [Post Workspace Create event handlers] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Post_Workspace_Create_event_handlers.htm): You can use Post Workspace Create event handlers to update database tables as part of the workspace creation process. You can also use them to make direct SQL calls and to perform other operations on a workspace or EDDS database. This event handler runs as the final task performed during workspace creation.
  - Second paragraph: For example, you might want to use a workspace with a custom application as a template. If the application includes custom tables on the workspace database, you can use a Post Workspace Create event handler to clear obsolete data from these tables when you create your new workspace and its database. You could also use this type of event handler to update tables in the EDDS with entries for a newly installed application in a workspace.
  - Headings: H1: Post Workspace Create event handlers | H2: Guidelines for Post Workspace Create event handlers | H2: Code sample for a Post Workspace Create event handler

- [Pre and Post Install event handlers] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_and_Post_Install_event_handlers_overview.htm): Pre and Post Install event handlers provide you with the ability to perform custom actions during the deployment of an application. For example, you can develop Pre Install event handlers that set default values on specific fields during installation, or Post Install event handlers that update fields immediately after an application is installed in a workspace.
  - Second paragraph: See these related pages:
  - Headings: H1: Pre and Post Install event handlers | H2: Run Pre and Post Install event handlers | H2: Log messages for Pre and Post Install event handlers

- [Pre Install event handlers] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_Install_event_handlers.htm): Develop Pre Install event handlers that run custom code during application installation, such as creating database tables. Includes guidelines and a sample DependencyCheckPreInstallEventHandler class.
  - Second paragraph: Use these guidelines when developing Pre Install event handlers:
  - Headings: H1: Pre Install event handlers | H2: Guidelines for Pre Install event handlers | H2: Code sample for a Pre Install event handler

- [Pre Uninstall event handlers] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_Uninstall_event_handlers.htm): You can use Pre Uninstall event handlers to perform cleanup tasks associated with removing an application from workspaces or from your  Relativity environment. For example, you can add functionality to clear entries from database tables or to drop unneeded tables.
  - Second paragraph: You can also use a template to create this event handler type. For more information, see Visual Studio templates.
  - Headings: H1: Pre Uninstall event handlers | H2: Guidelines for Pre Uninstall event handlers | H2: Code sample for  a Pre Uninstall event handler

- [Pre Workspace Delete event handlers] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_Workspace_Delete_event_handlers.htm): Using Pre Workspace Delete event handlers, you can remove unneeded application data from your database when you flag a workspace for deletion. The process of deleting a workspace automatically triggers the Pre Workspace Delete event handlers in all applications that contain them. These event handlers remove data that the applications may have created or needed in order to run in the deleted workspace. For example, they might clear entries from database tables, drop unneeded tables, or perform other clean-up tasks on the EDDS database. Pre Workspace Delete event handlers don’t need to remove tables or values from the workspace itself, since the delete operation performs these tasks.
  - Second paragraph: These event handlers remove data that the applications may create or need in order to run in the deleted workspace. For example, they might clear entries from database tables, drop unneeded tables, or perform other clean-up tasks on the EDDS database. Pre Workspace Delete event handlers don’t need to remove tables or values from the workspace itself, because the delete operation performs these tasks.
  - Headings: H1: Pre Workspace Delete event handlers | H2: Guidelines for Pre Workspace Delete event handlers | H2: Code sample for a Pre Workspace Delete event handler

- [Relativity Application Framework] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Relativity_applications.htm): The Relativity platform offers versatile options for extending and customizing core functionality. You can tailor Relativity to meet your organizational business needs by developing custom applications that you can install in multiple workspaces on one or many Relativity instances. Depending on your development goals, you can create new objects through the Relativity UI, and then enhance them with your own custom code and UI. The Relativity platform includes support for the development of agents, custom pages, and event handlers that you can easily package in your application, which you can then deploy in other workspaces or instances.
  - Second paragraph: See these related pages:
  - Headings: H1: Relativity Application Framework | H2: Use cases for extending Relativity | H2: Sample workflow for building applications

- [Troubleshoot application errors] (https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Troubleshooting_applications_errors.htm): You can use the information to view application errors and to resolve specific types of errors.
  - Second paragraph: To view application errors, open the detail view of an application. Click Show Errors on the Relativity Application console. Relativity enables this link only when an application has errors.
  - Headings: H1: Troubleshoot application errors | H2: View application errors | H2: Stack traces for install event handler failures | H2: Rerun RunOnce install event handlers | H2: Can't export due to unassigned event handlers or agents | H2: Can’t find assembly for event handler on an object type


### Cold Storage
- [Cold Storage] (https://platform.relativity.com/RelativityaiR/Content/Cold_Storage/Cold_Storage.htm): Find the Cold Storage business domain overview for managing workspaces in cold storage, including removed endpoints, links to .NET and REST content, and version history.
  - Second paragraph: The Cold Storage Manager service exposes endpoints for programmatically managing workspaces in Relativity cold storage. It includes the following features:
  - Headings: H1: Cold Storage | H2: Current Cold Storage API content | H2: Version History

- [Cold Storage Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/Cold_Storage/Cold_Storage_Manager_Net.htm): Use the Cold Storage Manager .NET API to move workspaces into or out of cold storage and to check a workspace
  - Second paragraph: As a sample use case, you might use the Cold Storage Manager service to automatically move workspaces in and out of cold storage, or keep track of the workspaces in cold storage in a Relativity application developed for your organization.
  - Headings: H1: Cold Storage Manager (.NET) | H2: Fundamentals for the Cold Storage Manager API | H3: Methods | H3: Classes and enumerations | H2: Guidelines for the Cold Storage Manager API | H3: Move Workspace Into Cold Storage | H3: Move Workspace Out Of Cold Storage | H3: Get Workspace Cold Storage Status

- [Cold Storage Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/Cold_Storage/Cold_Storage_Manager_REST.htm): Use the Cold Storage Manager REST service to move workspaces in or out of cold storage and check their status. Includes a Postman sample file, base URL, and path parameters.
  - Second paragraph: As a sample use case, you might use the Cold Storage Manager service to automatically move workspaces in and out of cold storage, or keep track of the workspaces in cold storage in a Relativity application developed for your organization.
  - Headings: H1: Cold Storage Manager (REST) | H2: Postman sample file | H2: Client code sample | H2: Move Workspace Into Cold Storage | H2: Move Workspace Out Of Cold Storage | H2: Get Workspace Cold Storage Status


### Collect
- [Collect API] (https://platform.relativity.com/RelativityaiR/Content/BD_Collect/Collect_API.htm): Use the Collect API to create and run collection jobs in Relativity aiR, generate and validate targets, monitor job status, and receive webhook events.
  - Second paragraph: Generate and validate targets (e.g., custodians and groups).
  - Headings: H1: Collect API | H2: Guidelines for the Collect API | H3: URLs | H3: Authentication & Authorization | H3: Bearer Token Authentication | H3: Authorization | H2: Error Model | H2: Idempotency & Rate Limits | H3: Idempotency | H3: Rate limits & concurrency | H2: Data Models | H3: CollectionJobModel | H3: Criteria (normalized) | H3: CreateCollectionAPIModel (request) | H3: StartJobResult | H3: TargetGenerationJobResults | H3: Webhook subscription | H3: Webhook event payload | H2: Endpoint Reference (CollectAPIController v1) | H3: Create Collection | H3: Start Target Generation | H3: Get Target Generation Job Results | H3: Start Collection | H3: Get Collection Status | H3: Stop Collection Job | H3: Additional (logical) endpoints from the model | H2: Limits & Constraints (v1) | H3: State machine | H2: Monitoring, Audit & Usage | H2: Security | H2: Pagination & Filtering | H2: End-to-End Example (cURL) | H3: Create a collection | H3: Start target generation | H3: Poll target generation results | H3: Start the collection | H3: Poll collection status | H3: Stop the collection (optional) | H3: Read artifacts/delivery outputs

- [Collect REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Collect/CollectRESTAPI1.html): Collect API REST Reference

- [Collect REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Collect/Collect_REST_API_Reference.htm): Browse the REST API reference for the Collect API.
  - Headings: H1: Collect REST API Reference


### Content
- [Included Topics] (https://platform.relativity.com/RelativityaiR/Content/IncludedTopics.htm)
  - Headings: H1: Included Topics

- [Search] (https://platform.relativity.com/RelativityaiR/Content/Search.htm)

- [Search Relativity Documentation] (https://platform.relativity.com/RelativityaiR/Content/CoveoSearch.htm): Search Relativity documentation, knowledgebase articles, events, news, and files.
  - Headings: H1: Search Results

- [Sitemap] (https://platform.relativity.com/RelativityaiR/Content/Sitemap.htm)
  - Headings: H1: Sitemap


### Contracts
- [Contracts] (https://platform.relativity.com/RelativityaiR/Content/BD_Contracts/Contracts.htm): Find the REST services for integrating with the Contracts application, including the Contracts Offsets and hOCR services, with version history.
  - Headings: H1: Contracts | H2: Current Contracts API content | H2: Version History

- [Contracts Offsets Service (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Contracts/Contracts_Offsets_Service__REST_.htm): Use the Contracts Offsets Service REST API to create and manage offsets that link field values to text in contract documents.
  - Second paragraph: The Contracts Offsets Service exposes CRUD endpoints that you can use to programmatically manipulate offsets in your Relativity environment.
  - Headings: H1: Contracts Offsets Service (REST) | H2: Guidelines for the Contracts Offsets Service | H3: URLs | H2: Client Code Example | H2: Create Offsets | H3: Request field descriptions | H3: Sample JSON request | H3: Response field descriptions | H3: Sample JSON response | H2: Read Offsets | H2: Update Offsets | H3: Request field descriptions | H3: Sample JSON Request | H3: Response field descriptions | H3: Sample JSON Response | H2: Delete An Offset | H2: Upsert Offsets

- [hOCR Service (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Contracts/hOCR_Service__REST_.htm): Use the Contracts hOCR Service REST API to read hOCR data created by the Contracts OCR Agent for each page of a document.
  - Second paragraph: The Contracts hOCR Service exposes an endpoint for reading hOCR data created by the Contracts OCR Agent.
  - Headings: H1: hOCR Service (REST) | H2: Guidelines for the hOCR Service | H3: URLs | H2: Client Code Example | H2: Read hOCR Data | H3: Response field descriptions | H3: Sample JSON response | H2: Adding or Updating hOCR Data | H3: Sample JSON body | H3: Sample JSON response


### Customizing the UI
- [Advanced functionality for custom pages] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Advanced_functionality_for_custom_pages.htm): You can further enhance the custom pages that you develop by incorporating advanced functionality in them. For example, you might want to use Forms or Windows authentication methods in your custom pages.
  - Second paragraph: You can configure applications that contain custom pages to use their own authentication systems. With custom authentication, you can create Relativity applications that use specialized access to application components. Relativity supports Forms Authentication or Windows Authentication methods.
  - Headings: H1: Advanced functionality for custom pages | H2: Custom authentication | H3: Manually enable Forms or Windows Authentication in IIS | H3: Enable Forms or Windows Authentication via your custom page's web.config

- [API replacements for route redirections] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Redirections.htm): Route redirections resulting from the migration of custom pages in Relativity aiR to the modernized compute platform
  - Second paragraph: -
  - Headings: H1: API replacements for route redirections | H2: Links and navigation | H2: Removed Routes

- [Basic concepts for custom pages] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Basic_concepts_for_custom_pages.htm): Review these basic concepts to learn more about the deployment, page linking, and other features of custom page functionality. For additional information, see Best practices for custom pages.
  - Second paragraph: See this related page:
  - Headings: H1: Basic concepts for custom pages | H2: Connect to the Services API with the client-side proxy | H2: Obtain user and other context information with API Helpers | H2: Custom page deployment | H2: Supported file types for custom pages | H2: Use URLs as links to custom pages | H3: Obtain the application GUID | H3: Deploy the custom page | H2: Use external tabs as links to custom pages | H3: Create tabs available in a workspace | H3: Create tabs available from Home | H2: Simplify custom page URLs | H2: Readiness check URL | H2: Use console event handlers to access custom pages

- [Best practices for custom pages] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Best_practices_for_custom_pages.htm): Use these guidelines to optimize your application development with custom pages.
  - Second paragraph: Use the helper classes so that you program to an interface. This interface provides functionality for returning a database context and connecting to the Services API. These helper classes are in Relativity API Helpers available when you reference the Relativity.API.dll in your projects. Codes samples for custom pages illustrate how to establish this connection with the helper classes. For more information, see Basic concepts for custom pages and Using Relativity API Helpers.
  - Headings: H1: Best practices for custom pages | H2: Use helper classes | H2: Secure custom pages as necessary | H2: Authorize users for operations | H2: Avoid using underscores to begin file names | H2: Don't use restricted file types for custom pages

- [Build a custom page] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Building_your_first_custom_page.htm): This tutorial illustrates how to create a custom page using Visual Studio templates.
  - Second paragraph: Your completed custom page displays your name and the current time in the Relativity UI.
  - Headings: H1: Build your first custom page | H2: Before you begin | H2: Build a custom page | H2: Deploy a custom page

- [Configuration Values] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Configuration_Values.htm): Retrieve Relativity configuration values, such as application paths, version, currency symbol, and instance GUID, using the property getters and function getters on window.relativity.
  - Second paragraph: There are two types of APIs available to retrieve configuration values:
  - Headings: H1: Configuration Values | H2: Property Getters | H2: Function Getters | H2: Deprecated Functions and Properties, and replacements | H3: Deprecated Functions | H3: Deprecated Properties

- [Custom Pages .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/CustomPagesNETAPI.html): Custom Pages .NET API Reference

- [Custom Pages .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Custom_Pages_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.CustomPages assembly.
  - Headings: H1: Custom Pages .NET API Reference | H2: Relativity.CustomPages

- [Custom Pages migration checklist] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Custom_Pages_migration.htm): Migration of custom pages in Relativity aiR to the modernized compute platform
  - Second paragraph: There are three potential ways in which Custom Pages may be impacted by this migration:
  - Headings: H1: Custom Pages migration checklist | H2: Determining if your Custom Page is affected | H2: JavaScript API changes | H2: Relativity-hosted assets changes | H2: Server-side requirements | H2: Frequently Asked Questions

- [Customize the UI] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Customizing_the_UI.htm): You can use custom pages to create your own look and feel for applications that you develop on the Relativity platform. You can develop your own cascading style sheets (CSS), JavaScript, HTML, and images that you can easily add to custom pages. In addition, custom pages can dynamically display or manipulate data stored in a Relativity database and Relativity Dynamic Objects (RDOs). They also facilitate the development of web applications that exist on top of Relativity but without directly interfacing with it. Consequently, custom pages support flexible application development for workflows tailored to your specific business needs.
  - Second paragraph: See these related pages:
  - Headings: H1: Custom pages

- [Debug] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Debug.htm): Use the relativity.debug object to collect environmental information in the browser developer tools, and add your custom page information to it, to help when reporting an issue to Relativity.
  - Second paragraph: Example:
  - Headings: H1: Debug | H2: Supported Surface Area of relativity.debug | H3: data | H3: info | H2: Getting your application's information into the debug information

- [errorApi] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/ErrorApi.htm): Use the relativity.internal.errorApi methods accessDenied and init to display error UIs, such as access denied overlays, from custom pages.
  - Second paragraph: Anything on relativity.internal.errorApi which is not listed below should not be used, and should be considered volatile (subject to change or removal without warning).
  - Headings: H1: errorApi | H2: Supported Surface Area of relativity.internal.errorApi | H3: accessDenied | H3: init | H3: noView | H3: permissionDenied | H3: workspaceVersion

- [How to find the main window from your custom page] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Find_the_main_window.htm): How to find the main window from your custom page
  - Second paragraph: To use the script below:
  - Headings: H1: How to find the main window from your custom page

- [Internal] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Internal.htm): Use the relativity.internal object to check system state and interact with the system, including getApi, getClickTrackingElements, and isActive. Lists the supported surface area.
  - Second paragraph: Anything on relativity.internal not listed in the supported surface area below should not be used, and should be considered volatile (subject to change or removal without warning).
  - Headings: H1: Internal | H2: Supported Surface Area of relativity.internal | H3: getApi | H3: getClickTrackingElements | H3: isActive | H3: isReady | H3: maximizeContent | H3: openSupport | H3: resetSessionExpirationTimeout | H3: restoreContent | H3: sessionActivityEvents | H3: toggleTabStrip | H2: Deprecated or Internally-used items

- [Navigation] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Navigation.htm): Use the relativity.navigation object to navigate or redirect within Relativity, including navigate and navigateToForms, and to check recent navigation history.
  - Second paragraph: Anything on relativity.navigation not listed in the supported surface area below should not be used, and should be considered volatile (subject to change or removal without warning).
  - Headings: H1: Navigation | H2: Supported Surface Area of relativity.navigation | H3: navigate | H3: navigateToForms | H3: navigateToListPage | H3: navigateToReview | H3: open | H3: peekCurrentUrl | H3: peekPreviousUrl | H3: popAndNavigateToPreviousUrl | H3: pushStateAndRecent | H3: redirect | H3: redirectHandler | H3: toSearchOrDocument | H3: toTag

- [Publish and upload custom pages] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Publishing_and_uploading_custom_pages.htm): To make your custom pages available to users, you need to publish the page to a specified location, and then upload it to a Relativity application. You can also use the PushResourceFiles() method on the RSAPIClient to add a custom page progammatically. See Using ADS through the Services API.
  - Second paragraph: You need to publish your Visual Studio project that contains your custom page before you can upload the files to Relativity.
  - Headings: H1: Publish and upload custom pages | H2: Publish your custom page project | H2: Upload a custom page file to Relativity | H3: Custom page layout fields

- [Removals and mitigation strategies] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Removals.htm): Removals and mitigation strategies resulting from the migration of custom pages in Relativity aiR to the modernized compute platform
  - Second paragraph: The recommended mitigation strategy for the following removed files/functionality is to house the functionality or script in your own application.
  - Headings: H1: Removals and mitigation strategies | H2: Strategy: Migrate Into the Application | H3: Hosted External Frameworks/Libraries | H2: Strategy: Replace dialog and modal functions with your app's specific frameworks and libraries | H2: Strategy: Replace with native JavaScript functionality | H2: Strategy: Replace usage with a new PageBase API or existing API | H3: HEAP click tracking | H3: Configuration values | H3: Other functions and properties | H2: Obsolete: discontinue use

- [Supported JavaScript APIs on Relativity's main window] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Supported_JavaScript_APIs.htm): Supported JavaScript APIs on Relativity
  - Second paragraph: Relativity's main window does contain properties and functions directly on the window and even within the relativity object which are not specified here. Anything not specifically called out in this topic should be considered volatile and is subject to change or removal without warning; please avoid using them. All properties and functions on the main window which are not on the relativity object fall into this category, and should not be used. Notable examples that you might be using currently are listed here.
  - Headings: H1: Supported JavaScript APIs on Relativity's main window | H2: Surface listing | H2: Details

- [Troubleshoot custom pages] (https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Troubleshooting_custom_pages.htm): You can use the following information to identify causes of deployment errors and to remotely debug custom pages. For information about configuring your environment for troubleshooting, see Development environment settings.
  - Second paragraph: Use these instructions to debug custom pages on a Relativity web server from your workstation:
  - Headings: H1: Troubleshoot custom pages | H2: Remotely debug custom pages | H2: Custom page installation errors | H2: Custom pages not deployed | H2: Readiness check is falling | H2: ApplicationServer table out-of-date | H2: Mismatched versions of .dll files | H2: Can't access custom page | H2: Can't upload custom pages published through Visual Studio 2015 and higher | H2: Find a custom page's physical deployment | H3: SQL


### Customizing workflows
- [Add event handlers to applications] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Adding_event_handlers_to_applications_or_objects.htm): After your event handler assembly builds successfully, you can upload it to an application or object in the Relativity UI. For more information, see Building your first event handler.
  - Second paragraph: Use the following procedure to add your event handler assembly to an application:
  - Headings: H1: Add event handlers to applications

- [Advanced functionality for event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Advanced_functionality_for_event_handlers.htm): You can further enhance the custom event handlers that you develop by incorporating advanced functionality in them.
  - Second paragraph: You can develop event handlers used to manipulate values that users store in different field types. The following list describes how to handle choice fields:
  - Headings: H1: Advanced functionality for event handlers | H2: Work with Choice field types | H3: Sample code for Choice fields | H2: Add assembly source information

- [Basic concepts for event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Basic_concepts_for_event_handlers.htm): Review these basic concepts to learn more about common implementation tasks required for event handler development, as well as how to use them to add custom behavior to your applications.
  - Second paragraph: Complete these common implementation tasks when developing custom event handlers:
  - Headings: H1: Basic concepts for event handlers | H2: Common implementation tasks for event handlers | H2: Manipulate or validate data with event handlers

- [Best practices for event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Best_practices_for_event_handlers.htm): Use these guidelines to optimize your application development with event handlers.
  - Second paragraph: Use these conventions when developing event handlers:
  - Headings: H1: Best practices for event handlers | H2: Use event handler coding conventions | H2: Use helper classes to create the client-side proxy | H2: Reference GUIDs | H2: Avoid using Choices with the same name | H2: Set the RunTarget attribute on event handlers | H2: Convert long running event handlers to agents

- [Build your first event handler] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Building_your_first_event_handler.htm): This tutorial illustrates how to create a simple event handler that updates the Name field on a  Relativity Dynamic Object (RDO) so that it displays the text.  Hello <your name>! The time is. <time>. It describes how to write the source code for this event handler, add references to your Visual Studio project, inherit from the event handler base class, override the Execute() method with your business logic, and perform other key development tasks. It also shows you how to add the compiled .dlls for the event handler to Relativity and execute the event handler on an RDO. For information about different types of event handlers, see Developing object type event handlers and Developing application event handlers.
  - Second paragraph: For information about different types of event handlers, see Develop object type event handlers and Develop application event handlers.
  - Headings: H1: Build your first event handler | H2: Before you begin | H2: Build an event handler

- [Console event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Console_event_handlers.htm): You create event handlers that execute when a user clicks a console button in Relativity. The details view of an object may display a console, which contains header text and a button collection. When a user clicks a button, a call is made to a method in the event handler that contains the business logic for a specific task. Console event handlers support custom HTML elements. In Relativity, the console has a GetConsole() method that returns a Console event handler. These event handlers are supported on Relativity Dynamic Objects.
  - Second paragraph: Console event handlers execute when a user clicks a console button in Relativity. The details view of an object may display a console, which contains header text and a button collection. When a user clicks a button, a call is made to a method in the event handler that contains the business logic for a specific task. In Relativity, the console has a GetConsole() method that returns a Console event handler. Console event handlers support custom HTML elements. You can use them on Relativity Dynamic Objects.
  - Headings: H1: Console event handlers | H2: Guidelines for Console event handlers | H2: Code sample for a Console event handler

- [Develop Mass Operation handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Developing_Mass_Operation_handlers.htm): You can create Mass Operation handlers that perform custom mass operations.  For example, you can develop a Mass Operation handler that submits a group of objects to an agent for some type of processing. You can also use a Mass Operation handler to update related items when a group of objects undergoes a mass edit. In Relativity, the drop-down menu in the mass operations bar displays your custom mass operations.
  - Second paragraph: To create a custom mass operation, you develop a class that inherits from the MassOperationHandler class. It resides in the kcura.EventHandler assembly under the kCura.MassOperationHandlers namespace. You can then add your custom Mass Operation handler as a resource file and associate it with an object type or an application in Relativity.
  - Headings: H1: Develop Mass Operation handlers | H2: Guidelines for Mass Operation handlers | H2: Code sample for a Mass Operation handler | H2: Convert legacy custom mass operations

- [Develop object type event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Developing_object_type_event_handlers.htm): The Relativity platform supports multiple types of event handlers that you can use for interactions with document and Relativity Dynamic Objects (RDOs). You can use these object type event handlers to customize workflows and control user activities in the Relativity UI. Since you can associate these event handlers with specific object types, you can write custom code to validate data entered in their fields, perform mass operations on several instances of an object simultaneously, and trigger specific events on the object when users click console buttons. For information about other event handler types, see Developing application event handlers.
  - Second paragraph: For information about other event handler types, see Develop application event handlers and Implementing Relativity Forms event handlers.
  - Headings: H1: Develop object type event handlers | H2: Using object type event handlers with Relativity Forms | H2: Using object type event handlers without Relativity Forms

- [Event Handler .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Event_Handler_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.EventHandler assembly.
  - Headings: H1: Event Handler .NET API Reference | H2: Relativity.EventHandler

- [Event Handler .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/EventHandlerNETAPI.html): Event Handler .NET API Reference

- [Event Handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Customizing_workflows.htm): You can customize workflows for your organization by using event handlers to apply unique business logic to documents and Relativity Dynamic Objects (RDOs). You can use event handlers to perform these and other operations in Relativity.
  - Second paragraph: See these related pages:
  - Headings: H1: Event Handlers

- [List Page Interaction Event Handler API] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/List_Page_Interaction_Event_Handler_API.htm): Use the List Page Interaction Event Handler JavaScript APIs to customize list pages. Covers deprecations and migration guidance to Relativity.Lists, and the JavaScript structure for these handlers.
  - Second paragraph: For a list of deprecations and changes to the APIs on this page, see Classic List Page API deprecation.
  - Headings: H1: List Page Interaction Event Handler API | H2: JavaScript structure for event handlers | H2: Summary of JavaScript APIs | H3: Initializer API | H3: Event-specific APIs | H3: General APIs | H2: Initializer API details | H2: Event-specific API details | H3: Page Navigation API | H3: New Item Button API | H3: Cell Formatter API | H3: Data Source Override API | H3: View API | H3: Widget Menu Customization API | H2: General APIs details | H3: Initialization information | H3: startup info object | H3: Promise API | H3: Events API | H3: Kepler Provider API | H3: Common Utilities API | H3: Modal API | H3: Toolbar API | H3: CustomWidget API | H2: Additional information about dataSource objects | H3: dataSource.inboundTransformer | H3: dataSource.outboundTransformer

- [List Page Interaction event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/List_Page_Interaction_event_handlers.htm): Implement List Page Interaction event handlers with external JavaScript files to send events, customize the new item button, open modals, and add data sources to Relativity list pages.
  - Second paragraph: Unlike other event handlers, List Page Interaction event handlers require external JavaScript files rather than code defined in the PopulateScriptBlocks() method as in Page Interaction event handlers. You implement List Page Interaction event handlers by creating JavaScript files with your custom code, and then specifying the names of these files in the ScriptFileNames and AdditionalHostedFileNames properties added to the .NET code. Your JavaScript code must use the JavaScript APIs developed specifically by Relativity for these event handlers. The JavaScript and any other supporting files are uploaded to Relativity separately from the DLL for the List Page Interaction event handler. Additionally, these event handlers must be associated with a Relativity application.
  - Headings: H1: List Page Interaction event handlers | H2: Special considerations for List Page Interaction event handlers | H2: Guidelines for List Page Interaction event handlers | H2: Code sample for a List Page Interaction event handler | H3: Sample JavaScript file | H2: Identifying the URL for a file | H2: Updating List Page Interaction event handlers

- [Page Interaction event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Page_Interaction_event_handlers.htm): Using the Page Interaction event handler, you can inject your own JavaScript code or load your Cascading Style Sheets (CSS) file on the view or edit page of an object. You can use this event handler to add specialized behavior to these pages, as well as control their look and feel.
  - Second paragraph: For example, you can add JavaScript to Page Interaction event handlers that controls the formatting of phone numbers entered in text boxes or validates a user's entry in a form. You can also use this type of event handler to alter the spacing between object types listed on a view page or modify the functionality of a console button.
  - Headings: H1: Page Interaction event handlers | H2: Guidelines for Page Interaction event handlers | H2: Code sample for a Page Interaction event handler | H2: Helper method for custom page URLs

- [Post Save event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Post_Save_event_handlers.htm): A Post Save event handler executes after a user clicks the Save or Save & Next button on a layout for a document or Relativity Dynamic Object (RDO) in the Relativity UI. It executes after the values entered by the user are written to the database as object properties. If you want to modify the object properties after the event handler writes to the database, you need to use the Relativity Services API to update the artifact on the database. Since the user has clicked the Save or Save & Next button, the save operation can’t be aborted from an Post Save event handler. Post Save event handlers are supported only on documents and RDOs.
  - Second paragraph: Use a Post Save event handler when you need to write the properties of one object to the database before you can instantiate a second object. For example, you may want to create an audit object after the event handler successfully saves another custom object. You can also use Post Save event handlers to send email notifications after a specific action is completed.
  - Headings: H1: Post Save event handlers | H2: Guidelines for Post Save event handlers | H2: Code sample for a Post Save event handler

- [Pre Cascade Delete event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Cascade_Delete_event_handlers.htm): You can call a Pre Cascade Delete event handler when a user attempts to force the deletion of an object with dependent objects. The user must have Delete Object Dependencies permissions to perform this action.
  - Second paragraph: You can use this type of event handler to verify that no restrictions exist on an object selected for deletion. For example, the Processing Set Pre Cascade Delete event handler prevents the deletion of a processing set while it is undergoing processing.
  - Headings: H1: Pre Cascade Delete event handlers | H2: Guidelines for Pre Cascade Delete event handlers | H2: Code sample for a Pre Cascade Delete event handler

- [Pre Delete event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Delete_event_handlers.htm): Pre Delete event handlers execute after a user clicks the Delete button or performs a Mass Delete in Relativity. These event handlers are supported on documents and Relativity Dynamic Objects (RDOs), as well as for mass delete operations.
  - Second paragraph: After Relativity deletes the target object, the event handler commits the delete database transaction. If an error occurs during this process, a rollback method is triggered and its code is called. You can then execute different code in the rollback method. As best practice, execute a Pre Cascade Delete event handler to perform validation on delete. Next, trigger the Pre Delete event handler.
  - Headings: H1: Pre Delete event handlers | H2: Guidelines for Pre Delete event handlers | H2: Code sample for a Pre Delete event handler

- [Pre Load event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Load_event_handlers.htm): Pre Load event handlers execute before a New, Edit or View page loads. Pre Load event handlers are often used to populate default values. You can use Pre Load event handlers for all fields on Dynamic Objects and documents. The event handlers have the following behavior.
  - Second paragraph: Pre Load event handlers execute before the new, edit, or view page layouts load.  Pre Load event handlers can be used populate default values. You can use Pre Load event handlers for all fields on Dynamic Objects and documents. The event handlers have the following behavior:
  - Headings: H1: Pre Load event handlers | H2: Guidelines for Pre Load event handlers | H2: Code sample for a Pre Load event handler

- [Pre Mass Delete event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Mass_Delete_event_handlers.htm): You can call a Pre Mass Delete event handler to apply an action once before deleting a large set of objects. Unlike a Pre Cascade Delete event handler, Pre Mass Delete doesn
  - Second paragraph: While you could use a Pre Delete event handler to execute a similar operation, it requires calling the Pre Delete event handler to delete each individual child object. In contrast, the Pre Mass Delete event handler provides an efficient way to run an action before deleting a whole set of children objects a the same time. For example, a Pre Mass Delete event handler can change the status of parent objects in a set before deleting their children.
  - Headings: H1: Pre Mass Delete event handlers | H2: Guidelines for   Pre Mass Delete event handlers | H2: Code sample for a  Pre Mass Delete event handler

- [Pre Save event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Save_event_handlers.htm): Pre Save event handlers execute after a user changes field values and clicks the Save or Save & Next button in Relativity. Since these event handlers run before the data on the object is written to the database, you can use them to manipulate information before it
  - Second paragraph: For example, you can use  Pre Save event handlers for the following tasks:
  - Headings: H1: Pre Save event handlers | H2: Guidelines for Pre Save event handlers

- [Redirect a user to a layout in a Pre Load event handler] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Redirecting_a_user_to_layout_in_a_Pre_Load_event_handler.htm): Use the RedirectToLayout class in a Pre Load event handler to send users to a specific layout, such as a read-only layout for produced documents. Includes a code sample.
  - Second paragraph: For example, you can use a Pre Load event handler to redirect users to a read-only layout, when they view produced documents that shouldn’t be edited. You can also use these event handlers to display layouts that contain only fields relevant to a specific document type. The event handler could redirect the users to one layout for email messages and another designed for PDFs.
  - Headings: H1: Redirect a user to a layout in a Pre Load event handler | H2: Sample code

- [Support for File fields] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Support_for_File_fields.htm): Use the FileValue and FileFieldValue classes in the kCura.EventHandler namespace to read or replace the file stream of a File field in event handlers, with a Pre Save code sample.
  - Second paragraph: In the kCura.EventHandler namespace, the FileValue class contains a FileStream method, which returns a new file stream. When a Pre Save event handler executes and a user uploaded a new file for a field through the UI, you can use the stream to access to file before storing it in Relativity. Otherwise, you can use the stream to access the file on the Relativity file share.
  - Headings: H1: Support for File fields | H2: Read a File field value | H2: Modify a File field value | H2: Clear a File field value

- [Troubleshoot event handlers] (https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Troubleshooting_event_handlers.htm): You can use these instructions to debug event handlers on a Relativity web server from your workstation. For information about configuring your environment for troubleshooting, see Development environment settings.
  - Headings: H1: Troubleshoot event handlers


### Data Visualization
- [Data Visualization .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/DataVisualizationNETAPI.html): Data Visualization .NET API Reference

- [Data Visualization .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Data_Visualization_NET_API_Reference.htm): Browse the .NET API reference for the Data Visualization business domain, provided in the Relativity.DataVisualization.SDK.
  - Headings: H1: Data Visualization .NET API Reference | H2: Relativity.DataVisualization.SDK

- [Data Visualization Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Data_Visualization.htm): Find the .NET and REST API content, version history, and supported versions for the Data Visualization business domain, covering layouts, tabs, views, and object rules.
  - Second paragraph: Tab Manager API - updated to a versioned API. Additionally, it includes the following updates:
  - Headings: H1: Data Visualization | H2: Current Data Visualization API content | H2: Version History

- [Data Visualization REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/DataVisualizationRESTAPI.html): Data Visualization REST API Reference

- [Data Visualization REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Data_Visualization_REST_API_Reference.htm): Browse the REST API reference for the relativity-data-visualization service.
  - Headings: H1: Data Visualization REST API Reference | H2: relativity-data-visualization

- [Layout Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Layout_Manager_API.htm): Use the .NET Layout Manager API to create, read, update, and delete layouts, and to retrieve users who can own layouts.
  - Second paragraph: The Layout Manager API exposes CRUD operations that you can use to programmatically manipulate layouts in your Relativity environment. In addition to the CRUD operations, this API includes a helper function used to retrieve a list of users with permissions necessary to own layouts.
  - Headings: H1: Layout Manager (.NET) | H2: Fundamentals for the Layout Manager API | H2: Create a layout | H2: Read a layout | H2: Update a layout | H2: Delete a layout | H2: Retrieve users for layout ownership

- [Layout Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Layout_Manager_service.htm): Use the Layout Manager REST service to create, read, update, and delete layouts, and to retrieve users who can own layouts.
  - Second paragraph: The Layout Manager service exposes CRUD endpoints that you can use to programmatically manipulate layouts in your Relativity environment. In addition to the CRUD endpoints, this API includes a helper endpoint used to retrieve a list of users with permissions necessary to own layouts.
  - Headings: H1: Layout Manager (REST) | H2: Guidelines for the Layout Manager service | H3: URLs | H2: Client code sample | H2: Create a layout | H2: Read a layout | H2: Update a layout | H2: Delete a layout | H2: Retrieve users for layout ownership

- [Object Rule Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Object_Rule_Manager_API.htm): Use the .NET Object Rule Manager API to create, update, and delete object rules and to retrieve associative objects, layouts, and choices used by rules.
  - Second paragraph: You can also use the Object Rule Manager and other related services through the REST API. For more information, see Object Rule Manager (REST).
  - Headings: H1: Object Rule Manager (.NET) | H2: Fundamentals for managing object rules | H2: Guidelines for the Object Rule Manager API | H2: Create an object rule | H2: Read an object rule | H2: Update an object rule | H2: Delete an object rule | H2: Delete multiple object rules | H2: Retrieve choices, choice fields, layouts, or associated objects

- [Object Rule Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Object_Rule_Manager_service.htm): Use the Object Rule Manager REST service to manage object rules that customize object type behavior, and download Postman sample files for the endpoints.
  - Second paragraph: You can also work with this service through .NET. For more information, see Object Rule Manager (.NET).
  - Headings: H1: Object Rule Manager (REST) | H2: Postman sample files | H2: Guidelines for the Object Rule Manager service | H2: Fundamentals for Object Rule Manager service | H2: Create an object rule | H2: Read an object rule | H2: Update an object rule | H2: Delete an object rule | H2: Delete multiple object rules | H2: Retrieve choices, choice fields, layouts, or associated objects

- [Tab Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Tab_Manager_API.htm): Use the .NET Tab Manager API to create, read, update, and delete tabs and to retrieve tab display order, parent tabs, and eligible object types.
  - Second paragraph: As a sample use case, you might use the Tab Manager service to add specialized tab functionality to custom pages in a Relativity application developed for your organization.
  - Headings: H1: Tab Manager (.NET) | H2: Fundamentals for managing tabs | H2: Guidelines for using the Tab Manager service | H3: Access the Tab Manager service | H3: Admin-level context | H3: Retrieve a value from a Task object | H3: Set ParentID property | H3: Use of response data from read operations | H3: IconIdentifier property | H2: Create a tab | H2: Retrieve tab metadata | H2: Update a tab | H2: Delete a tab | H2: Retrieve object types for a tab | H2: Retrieve eligible parent tabs | H2: Retrieve workspace-level metadata for admin and system tabs | H2: Retrieve tab orders | H2: Retrieve all tabs for navigation

- [Tab Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Tab_Manager_service.htm): Use the Tab Manager REST service to create, read, update, and delete tabs, including admin-level tabs, and to retrieve tab display order and parent tabs.
  - Second paragraph: As a sample use case, you might use the Tab Manager service to add specialized tab functionality to custom pages in a Relativity application developed for your organization.
  - Headings: H1: Tab Manager (REST) | H2: Guidelines for the Tab Manager service | H3: URLs | H3: JSON payloads for create and update operations | H3: IconIdentifier field | H2: Client code sample | H2: Create a tab | H2: Retrieve tab metadata | H2: Update a tab | H2: Delete a tab | H2: Retrieve object types for a tab | H2: Retrieve eligible parent tabs | H2: Retrieve workspace-level metadata for admin and system tabs | H2: Retrieve tab orders | H2: Retrieve all tabs for navigation

- [View Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/View_Manager_API.htm): Use the .NET View Manager API to create, read, and update views and to retrieve view permissions, search condition fields, eligible owners, and object types.
  - Second paragraph: As a sample use case, you could use the View Manager API to add or modify views used in a custom application or through the Relativity UI. For example, you might want to create a view that uses a specific set of search criteria to display custom objects in an application.
  - Headings: H1: View Manager (.NET) | H2: Fundamentals for the View Manager API | H2: Create a view in a workspace | H2: Retrieve information about a view | H2: Update the properties of a view | H2: Retrieve the access status of a user | H2: Retrieve users for view ownership | H2: Retrieve a list of object types in the workspace

- [View Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/View_Manager_service.htm): Use the View Manager REST service to create, read, and update views and to retrieve view permissions, search condition fields, eligible owners, and object types.
  - Second paragraph: As a sample use case, you could use the View Manager API to add or modify views used in a custom application or through the Relativity UI. For example, you might want to create a view that uses a specific set of search criteria to display custom objects in an application.
  - Headings: H1: View Manager (REST) | H2: Guidelines for the View Manager service | H3: URLs | H2: Postman sample file | H2: Client code sample | H2: Create a view | H2: Retrieve information about a view | H2: Update a view | H2: Retrieve the access status of a user | H2: Retrieve users for view ownership | H2: Retrieve a list of object types in a workspace


### Document Viewer
- [Annotations Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Annotations_Manager__REST_.htm): Use the Annotations Manager REST service to create, update, retrieve, and delete redactions and highlights on document images in the Image Viewer.
  - Second paragraph: The Annotations Manager service exposes functionality for programmatically redacting and highlighting document images. It contains methods for creating, updating, retrieving, and deleting redactions and highlights.
  - Headings: H1: Annotations Manager (REST) | H2: Guidelines for using the Annotations Manager service | H3: URLs | H2: Client code sample | H2: Create or update annotations | H2: Retrieve annotations on a document | H2: Delete annotations from a document

- [Document Viewer] (https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer.htm): Find the .NET and REST API content, version history, and supported versions for the Document Viewer business domain, including annotations, highlights, and short messages.
  - Headings: H1: Document Viewer | H2: Current Document Viewer API content

- [Document Viewer .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/DocumentViewerNETAPI.html): Document Viewer .NET API Reference

- [Document Viewer .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer_NET_API_Reference.htm): Browse the .NET API reference for the Document Viewer business domain, provided in the Relativity.DocumentViewer.SDK.
  - Headings: H1: Document Viewer .NET API Reference | H2: Relativity.DocumentViewer.SDK

- [Document Viewer Services (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer_Services_API.htm): Use the .NET Document Viewer Services API to request conversion of documents and RDO file fields to viewer types such as native, image, production, and transcript.
  - Second paragraph: The following sample use cases illustrate how you can use these cache entries to create custom viewers or workflows for displaying documents:
  - Headings: H1: Document Viewer Services (.NET) | H2: Fundamentals for the Document Viewer Services API | H2: Best practices for the conversion requests | H2: Convert documents | H2: Convert files contained in File fields on RDOs

- [Document Viewer Services (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer_Services_in_REST.htm): Use the Document Viewer Services REST API to request conversion of documents and RDO file fields to viewer types such as native, image, production, and transcript.
  - Second paragraph: The following sample use cases illustrate how you can use these cache entries to create custom viewers or workflows for displaying documents:
  - Headings: H1: Document Viewer Services (REST) | H2: Guidelines for using the Document Viewer Services | H3: URLs | H2: Client code samples | H2: Convert documents | H2: Convert files contained in File fields on RDOs

- [Persistent Highlight Service (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Persistent_Highlight_Service__REST_.htm): Use the Persistent Highlight Service REST API to retrieve persistent highlight sets and terms, toggle them active or inactive, and add new terms.
  - Second paragraph: The Persistent Highlight Service provides the following functionality for programmatically working with these sets:
  - Headings: H1: Persistent Highlight Service (REST) | H2: Guidelines for using the Persistent Highlight Service | H3: URLs | H2: Retrieve persistent highlight sets | H2: Change the state of a persistent highlight set | H2: Add new terms to a persistent highlight set

- [Review Service REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Review_Service_REST_API_Reference.htm): Browse the REST API reference for the Review Service, relativity-reviewservice.
  - Headings: H1: Review Service REST API Reference | H2: relativity-reviewservice

- [Review Service REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/ReviewServiceRESTAPI.html): Review Service REST Reference

- [Short Message Viewer Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Short_Message_Viewer_Manager__REST_.htm): Use the Short Message Viewer Manager REST service to retrieve JSON, attachments, and participants for short messages, validate RSMF, and create documents from message subsets.
  - Second paragraph: The Short Message Viewer API exposes endpoints for retrieving the JSON, attachments, and participant information for short messages. It also provides endpoints for validating the Relativity Short Message Format (RSMF) and creating new documents based on a subset of messages.
  - Headings: H1: Short Message Viewer Manager (REST) | H2: Guidelines for using the Short Message Viewer Manager service | H3: URLs | H2: Retrieve the JSON for a short message | H2: Retrieve attachment information for a short message | H2: Retrieve entity information for a participant in a short message document | H2: Validate the RSMF for a document | H3: Validate the RSMF for a document | H2: Use slicing to create a new document with short message events


### Downloads
- [Downloading the SDK] (https://platform.relativity.com/RelativityaiR/Content/Downloads/Download_the_SDKs.htm): You can download the most recent versions of the SDK installer from the Relativity Developers site.
  - Second paragraph: (REST-only API)
  - Headings: H1: Download the SDKs and NuGet packages | H2: Integration APIs | H2: Extension APIs

- [Visual Studio templates] (https://platform.relativity.com/RelativityaiR/Content/Downloads/Relativity_templates_for_Visual_Studio.htm): You can streamline your application development by using Relativity templates for Visual Studio 2012 and 2013. Available templates include those for agents, custom pages, and event handler types. They contain required attributes, inherit from base classes as necessary, and include any methods that you need to override. In addition, they include library references to .dlls required to build a specific Relativity component. You must install the Relativity SDK to update the references in the template. Next, you simply modify the text in any placeholders that the template includes and then add your custom code to the file.
  - Second paragraph: The templates are available in the relativitydev GitHub repository as an open source project: https://github.com/relativitydev/relativity-templates.
  - Headings: H1: Visual Studio templates | H2: Available Relativity templates | H2: Install the Relativity templates | H3: Download templates from Visual Studio Marketplace | H3: Add templates through Visual Studio | H2: Use the Relativity project templates | H2: Use the Relativity item templates | H2: Relativity Manager-Worker Agent template | H3: Agents | H3: Agents.NUnit | H3: CustomPages | H3: CustomPages.NUnit | H3: EventHandlers | H3: EventHandlers.NUnit | H3: Helpers | H3: Helpers.NUnit


### dtSearch
- [dtSearch (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_API_old.htm): Relativity
  - Second paragraph: The Services API supports the create, read, update, delete, and query operations on a dtSearch DTO. Helper methods to easily return saved search parameters available to the user in the workspace, such as fields, search owners, search indexes are also provided. You can also generate email links to the search results. The operations on dtSearch DTOs  are performed asynchronously. Note that asynchronous operations return a standard .NET System.Threading.Tasks.Task<TResult> object that can be used to monitor progress and interact with the process.
  - Headings: H1: dtSearch (.NET) | H2: dtSearch properties | H2: Create a dtSearch | H2: Read a dtSearch | H2: Update a dtSearch | H2: Delete a dtSearch | H2: Query dtSearches | H2: Helper methods | H2: Email a link to dtSearch | H2: Move a dtSearch | H2: Copy a dtSearch | H2: Exception handling | H3: ServiceException | H3: ValidationException

- [dtSearch (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_service_old.htm): This topic describes how to interact with the Relativity saved dtSearch using the REST API.
  - Second paragraph: You can only use the POST method when interacting with the service.
  - Headings: H1: dtSearch (REST) | H2: Client code sample | H2: Create | H2: Read | H2: Update | H2: Delete | H2: Query | H2: Move | H2: Copy | H2: Helper operations | H3: GetEmailToLinkUrlAsync | H3: GetFieldsForCriteriaConditionAsync | H3: GetFieldsForObjectCriteriaCollectionAsync | H3: GetFieldsForSearchResultViewAsync | H3: GetSearchIncludesAsync | H3: GetSearchIndexesAsync | H3: GetSearchOwnersAsync | H3: GetAccessStatusAsync

- [dtSearch .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearchNETAPI.html): dtSearch .NET API Reference

- [dtSearch Business Domain] (https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch.htm): Find the .NET and REST API content, version history, release notes, and supported version ranges for the dtSearch business domain.
  - Headings: H1: dtSearch | H2: Current dtSearch API content | H2: Version History

- [dtSearch Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_API.htm): Use the .NET dtSearch Manager API to programmatically create, build, and manage dtSearch indexes through the IDtSearchIndexManager interface.
  - Second paragraph: In order to perform a dtSearch search, you must build and activate a dtSearch index. The  dtSearch Index Manager API exposes these operations, and others, letting you programmatically manage dtSearch Indexes. A sample use case for the dtSearch Manager API is creating a custom application to programmatically run through the stages of index build rather than manually performing these tasks through the Relativity UI.
  - Headings: H1: dtSearch Manager (.NET) | H2: Fundamentals for the dtSearch Manager API | H3: Methods  | H2: CRUD operations | H3: Create a dtSearch index | H3: Retrieve index metadata | H3: Update a dtSearch index | H3: Delete a dtSearch index | H3: Move a dtSearch index | H2: Index build operations | H3: Build Index: Full | H3: Build Index: Incremental | H3: Build Index | H3: Cancel a dtSearch index build | H3: Activate a dtSearch index | H3: Deactivate a dtSearch index | H3: Compress a dtSearch index | H3: Swap a dtSearch index | H3: Retry errors on a dtSearch index | H2: Helper methods | H3: Get active indexes | H3: Get saved searches  | H3: Get index share locations  | H3: Track dtSearch index build progress

- [dtSearch Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_service_in_REST.htm): Use the dtSearch Manager REST service to programmatically create, build, and manage dtSearch indexes in a workspace.
  - Second paragraph: In order to perform a dtSearch search, you must build and activate a dtSearch index. The  dtSearch Index Manager API exposes these operations, and others, letting you programmatically manage dtSearch Indexes. A sample use case for the dtSearch Manager API is creating a custom application to programmatically run through the stages of index build rather than manually performing these tasks through the Relativity UI.
  - Headings: H1: dtSearch Manager (REST) | H2: URLs | H2: Operations

- [dtSearch Manager .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_NET_API_Reference.htm): Browse the .NET API reference for the dtSearch Manager, provided in the Relativity.DtSearch.SDK.
  - Headings: H1: dtSearch Manager .NET API Reference | H2: Relativity.DtSearch.SDK

- [dtSearch Manager REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_REST_API_Reference.htm): Browse the REST API reference for the dtSearch Manager, relativity-dtsearch.
  - Headings: H1: dtSearch Manager REST API Reference | H2: relativity-dtsearch

- [dtSearch REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearchRESTAPI.html): dtSearch REST Reference


### Environment
- [Application Install (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Application_Install_API.htm): Use the .NET Application Install API to install applications into workspaces, cancel pending installs, check install status, and resolve conflicts from failed installs.
  - Second paragraph: You can also use the Application Install API through REST. For more information, see Application Install service.
  - Headings: H1: Application Install (.NET) | H2: Guidelines for the Application Install API | H3: Admin-level context | H3: Actions and pagination | H3: Permissions | H3: Sample use cases | H3: Create a proxy | H2: Install an application library to specific workspaces | H2: Install an application library to all workspaces | H2: Retrieve the installation status of an application | H2: Retrieve the number of workspaces with an outdated application | H2: Cancel pending application installations | H2: Retrieve installation details for an application | H2: Generate an installation report | H2: Cancel pending application installations | H2: Retrieve installation status by workspace | H3: Supported Condition Fields | H2: Query for application installations by identifier | H2: Validate new artifact names | H2: Query for application installations with additional fields | H2: Workflow-Based code samples

- [Application Install (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Application_Install_service.htm): Use the Application Install REST service to install applications into workspaces, cancel pending installs, check install status, and resolve failed install conflicts.
  - Second paragraph: You can also use the Application Install service through .NET. For more information, see Application Install (.NET).
  - Headings: H1: Application Install (REST) | H2: Client code sample | H2: Field descriptions for JSON requests | H2: Install an application library to specific workspaces | H2: Install an application library to all workspaces | H2: Retrieve the installation status of an application | H2: Retrieve the number of workspaces with an outdated application | H2: Cancel pending application installations | H2: Retrieve installation details for an application | H2: Generate an installation report | H2: Cancel pending application installations | H2: Retrieve installation status by workspace | H2: Query for application installations by identifier | H2: Validate new artifact names | H2: Query for application installations with additional fields

- [Environment .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Environment_NET_API_Reference.htm): Browse the .NET API reference for the Environment business domain, provided in the Relativity.Environment.SDK.
  - Headings: H1: Environment .NET API Reference | H2: Relativity.Environment.SDK

- [Environment .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/EnvironmentNETAPI.html): Environment .NET API Reference

- [Environment Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Environment.htm): Find the .NET and REST API content, version history, and changelog for the Environment business domain, which configures the Relativity installation or tenant.
  - Headings: H1: Environment | H2: Current Environment API content | H2: Version History

- [Environment REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/EnvironmentRESTAPI.html): Environment REST API Reference

- [Environment REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Environment_REST_API_Reference.htm): Browse the REST API reference for the Environment business domain, relativity-environment.
  - Headings: H1: Environment REST API Reference | H2: relativity-environment

- [Error Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Error_Manager_API.htm): Error Manager exposes single endpoint for creating errors, which can be displayed in Error tab in Relativity.
  - Second paragraph: You can also interact with the Error Manager API through the REST API. See Error Manager service.
  - Headings: H1: Error Manager (.NET) | H2: Guidelines for Error Manager API | H2: Fundamentals for using Error Manager | H3: Key concepts or other explanatory information | H3: Guidelines or best practices | H2: Create an error log | H3: Create an error log using service manager (recommended) | H3: Create an error log using an HTTP client

- [Error Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Error_Manager_service.htm): Through the REST API, Error Manager exposes single endpoint for creating errors, which can be displayed in Error tab in Relativity.
  - Second paragraph: You can use this to create a single error log which can be found on the Error tab in Relativity using a returned ArtifactID.
  - Headings: H1: Error Manager (REST) | H2: Guidelines for the Error Manager service | H2: Postman sample file | H2: Create an error log

- [Export (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Export_API.htm): Use the .NET Export API to export an application from a workspace as a RAP file or schema file, with ExportAsync code samples.
  - Second paragraph: You can also interact with the Export API through the REST API. See Export service.
  - Headings: H1: Export (.NET) | H2: Guidelines for the Export API | H3: Permissions | H2: ExportAsync | H2: ExportSchemaAsync

- [Export (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Export_service.htm): Use the Export REST service to export an application from a workspace as a RAP file or schema file, with a client code sample.
  - Second paragraph: To use the Export service, send requests by making calls with the required HTTP methods. See the following base URL for this service:
  - Headings: H1: Export (REST) | H2: Client code sample | H2: ExportAsync | H2: ExportSchemaAsync

- [Instance Setting Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Instance_Setting_Manager_API.htm): Use the .NET Instance Setting Manager API to create, read, update, and delete instance settings in a Relativity environment.
  - Second paragraph: Sample use cases for the Instance Setting Manager API include:
  - Headings: H1: Instance Setting Manager (.NET) | H2: Fundamentals for the Instance Settings Manager API | H2: Create an instance setting | H2: Read an instance setting | H2: Update an instance setting | H2: Delete an instance setting | H2: Helper method in code samples

- [Instance Setting Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Instance_Setting_Manager_service.htm): Use the Instance Setting Manager REST service to create, read, update, and delete instance settings in a Relativity environment.
  - Second paragraph: Sample use cases for the Instance Setting Manager service include:
  - Headings: H1: Instance Setting Manager (REST) | H2: Guidelines for the Instance Setting Manager service | H3: URLs | H2: Postman sample file | H2: Client code sample | H2: Create an instance setting | H2: Read an instance setting | H2: Update an instance setting | H2: Delete an instance setting

- [Library Application  (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Library_Application_API.htm): The Library Application API allows clients to read application metadata and RAP files from the library, upload new applications, and update or delete existing applications. The API also provides endpoints for managing which workspaces an application is installed into.
  - Second paragraph: You can also interact with the Library Application API through the REST API. See Library Application service.
  - Headings: H1: Library Application  (.NET) | H2: Guidelines for the Library Application API | H3: Admin-level context | H3: Permissions | H3: Sample use cases | H3: Endpoints | H2: CreateAsync | H2: ReadAsync | H2: ReadAllAsync | H2: ReadApplicationContentsAsync | H2: UpdateAsync | H2: DeleteAsync | H2: GetLibraryInstallStatusAsync | H2: RetryLibraryInstallAsync | H2: CancelLibraryInstallAsync | H2: UploadPackageAsync | H2: DownloadPackageAsync | H2: DeletePackageAsync | H2: GetApplicationHostingStatusAsync | H2: Workflow-Based code samples

- [Library Application (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Library_Application_service.htm): Through the REST API, the Library Application API allows clients to read application metadata and RAP files from the library, upload new applications, and update or delete existing applications.
  - Second paragraph: Review the following guidelines for working with this service.
  - Headings: H1: Library Application (REST) | H2: Guidelines for the Library Application service | H3: URLs | H2: Client code sample | H2: Create a library application | H2: Read a library application | H2: Read all library applications | H2: Retrieve a library application as a RAP file | H2: Update a library application | H2: Delete a library application | H2: Retrieve the installation status of an application | H2: Retry installing an application | H2: Cancel an application installation | H2: Upload a RAP or XML file | H2: Download a RAP or XML file | H2: Delete a RAP file | H2: Retrieve hosting status of an application

- [Matter Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Matter_Manager_API.htm): Use the .NET Matter Manager API to create, read, update, and delete matters, and to retrieve eligible clients and statuses.
  - Second paragraph: The Matter Manager API exposes multiple methods for programmatically managing matters in your Relativity environment. It includes the following features:
  - Headings: H1: Matter Manager (.NET) | H2: Retrieve a list of available clients | H2: Retrieve a list of matter statuses | H2: Create a matter | H2: Retrieve metadata for a matter | H2: Update a matter | H2: Delete a matter

- [Matter Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Matter_Manager_service.htm): This topic describes how to interact with the Relativity Matter object using the REST API.
  - Second paragraph: The Matter Manager service exposes multiple endpoints for programmatically managing matters in your Relativity environment. It includes the following features:
  - Headings: H1: Matter Manager (REST) | H2: Guidelines for the Matter Manager service | H3: URLs | H2: Postman sample file | H2: Retrieve a list of available clients | H2: Retrieve a list of matter statuses | H2: Create a matter | H2: Retrieve metadata for a matter | H2: Update a matter | H2: Delete a matter

- [Resource File (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Resource_File_API.htm): Use the .NET Resource File API to create, read, update, delete, and download resource files for applications, and to list eligible applications.
  - Second paragraph: You can also interact with the Resource File API through the REST API. See Resource File service.
  - Headings: H1: Resource File (.NET) | H2: Guidelines for the Resource File API | H3: Admin-level context | H3: Sample use cases | H3: Endpoints | H3: Permissions | H2: ReadAsync | H3: Permissions | H2: UpdateAsync | H3: Permissions | H2: DeleteAsync | H3: Permissions | H2: DownloadContentsAsync | H3: Permissions | H2: UploadContentsAsync | H3: Permissions | H2: UpsertAsync | H3: Permissions | H2: GetEligibleApplicationsAsync | H3: Permissions | H2: PushResourceFiles

- [Resource File (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Resource_File_service.htm): Use the Resource File REST service to create, read, update, delete, and download resource files for applications, and to list eligible applications.
  - Second paragraph: Review the following guidelines for working with this service.
  - Headings: H1: Resource File (REST) | H2: Guidelines for the Resource File service | H3: URLs | H2: Client code sample | H2: Read a resouce file | H2: Update a resource file | H2: Delete a resource file | H2: Download the contents of a resource file | H2: Upload the contents of a resource file | H2: Create or update a resource file | H2: Retrieve available applications

- [Workspace Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Workspace_Manager_API.htm): Use the .NET Workspace Manager API to create, read, update, and delete workspaces and retrieve helper data such as matters, clients, and Azure credentials. Notes deprecated endpoints.
  - Second paragraph: The Workspace Manager API supports the following functionality:
  - Headings: H1: Workspace Manager (.NET) | H2: Fundamentals for the Workspace Manager API | H3: Methods | H3: Classes | H2: Guidelines for the Workspace Manager API | H3: NuGet package | H3: Create a proxy | H3: Field permissions | H3: Cancellation and progress | H2: Create operation helper methods | H3: Retrieve unsupported fields for a create operation | H2: Retrieve a workspace | H2: Update a workspace | H2: Retrieve workspace statistics | H2: Resource information helper methods | H2: Advanced settings helper methods | H3: Retrieve available statuses for a workspace | H3: Retrieve full text languages for SQL Server

- [Workspace Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Workspace_Manager_service.htm): Use the Workspace Manager REST service to create, read, update, and delete workspaces and retrieve helper data such as matters, clients, and Azure credentials. Notes deprecated endpoints.
  - Second paragraph: The Workspace Manager service supports the following functionality:
  - Headings: H1: Workspace Manager (REST) | H2: Guidelines for the Workspace Manager service | H3: URLs | H2: Client code sample | H2: Create operation helper methods | H3: Retrieve unsupported fields for a create operation | H2: Retrieve a workspace | H2: Update a workspace | H2: Retrieve workspace statistics | H2: Advanced settings helper methods | H3: Retrieve available statuses for a workspace | H3: Retrieve full text languages for SQL Server | H3: Retrieve saved searches for production restrictions


### Explore
- [.NET APIs Reference] (https://platform.relativity.com/RelativityaiR/Content/Explore/NET_API_Reference.htm): Browse the available .NET API references using the table of contents or the list on this page.
  - Headings: H1: .NET APIs Reference

- [APIs Reference Content] (https://platform.relativity.com/RelativityaiR/Content/Explore/API_Reference.htm): Browse the available API references for .NET, REST, and JavaScript APIs using the table of contents or the list on this page.
  - Headings: H1: APIs Reference

- [Developer Tools and Resources] (https://platform.relativity.com/RelativityaiR/Content/Explore/Tools-Resources.htm): Find developer tools and resources, including the Developer Toolkit, local debugger, Publish to Relativity tool, NuGet packages, release notes, and documentation archives.
  - Second paragraph: Whether you're an experienced Relativity partner, a third-party software developer, or you're new to Relativity development, there are several ways for you to engage with the community to get and give advice, exchange code, and share your feedback about APIs and features. Here are some options for obtaining developer support and interacting with our community:
  - Headings: H1: Developer Tools and Resources | H2: Developer Support | H2: Other Tools and utilities | H2: Sites

- [Developer Tutorials] (https://platform.relativity.com/RelativityaiR/Content/Explore/Tutorials.htm): Find developer tutorials for integrating with and extending Relativity aiR, plus an advanced lesson series that builds a complete application importing Wikipedia data.
  - Second paragraph: These short tutorials cover the basics of building your own (self-hosted) applications that integrate with Relativity aiR.
  - Headings: H1: Developer Tutorials | H2: Integrating with Relativity | H2: Extending Relativity | H2: Advanced tutorials

- [Explore the Relativity Platform] (https://platform.relativity.com/RelativityaiR/Content/Explore/Explore.htm): Start here to explore Relativity developer content, including what

- [Introduction to Relativity aiR for Developers] (https://platform.relativity.com/RelativityaiR/Content/Explore/Introduction.htm): Introduction to Relativity aiR for Developers, the landing page for developer documentation.
  - Headings: H1: Relativity aiR for Developers | H2: Extending Relativity vs. Integrating with Relativity

- [JavaScript APIs Reference] (https://platform.relativity.com/RelativityaiR/Content/Explore/JS_API_Reference.htm): Browse the available JavaScript API references using the table of contents or the list on this page.
  - Headings: H1: JavaScript APIs Reference

- [Relativity aiR APIs] (https://platform.relativity.com/RelativityaiR/Content/Explore/Platform-APIs.htm): Learn how the Relativity aiR platform APIs let you programmatically perform tasks such as creating workspaces and adding users, and find the integration and extension APIs.
  - Second paragraph: (REST-only API)
  - Headings: H1: Relativity aiR APIs | H2: Integration APIs | H2: Extension APIs

- [REST APIs Reference] (https://platform.relativity.com/RelativityaiR/Content/Explore/REST_API_Reference.htm): Browse the available REST API references using the table of contents or the list on this page.
  - Headings: H1: REST APIs Reference


### Export
- [Export SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Export/ExportNETAPI.html): Export SDK .NET API Reference

- [Export SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Export/Export_NET_API_Reference.htm): Browse the .NET API reference for the Export business domain, provided in the Relativity.Export.SDK.
  - Headings: H1: Export .NET API Reference | H2: Relativity.Export.SDK


### Extend
- [Developer Tools and Resources] (https://platform.relativity.com/RelativityaiR/Content/Extend/Tools-Resources.htm): Find tools and resources for extension developers, including the Developer Toolkit, local debugger, Publish to Relativity tool, NuGet packages, and documentation archives.
  - Second paragraph: Whether you're an experienced Relativity partner, a third-party software developer, or you're new to Relativity development, there are several ways for you to engage with the community to get and give advice, exchange code, and share your feedback about APIs and features. Here are some options for obtaining developer support and interacting with our community:
  - Headings: H1: Developer Tools and Resources | H2: Developer Support | H2: Other Tools and utilities | H2: Sites

- [Extend the Relativity Platform] (https://platform.relativity.com/RelativityaiR/Content/Extend/Extend.htm): Learn about the Relativity extensibility points, such as custom pages, agents, and event handlers, and find links to fundamentals, tutorials, how-tos, best practices, and APIs.
  - Headings: H1: Extend the Relativity Platform

- [Extension tutorials] (https://platform.relativity.com/RelativityaiR/Content/Extend/Tutorials.htm): Find short tutorials on writing code, hosted on the Relativity Platform, that extends the standard functionality of Relativity aiR.
  - Headings: H1: Tutorials for extending Relativity aiR

- [Integration APIs and Services] (https://platform.relativity.com/RelativityaiR/Content/Extend/APIS-Services.htm): Find the extension APIs and services available for extending the Relativity platform.
  - Headings: H1: Extension APIs and Services

- [Introduction to Relativity extensions] (https://platform.relativity.com/RelativityaiR/Content/Extend/Introduction.htm): Learn about the extensibility points for extending Relativity with .NET code, including agents, Kepler APIs, custom pages, event handlers, and API Helpers.
  - Second paragraph: Platform extension APIs (also known as Extensibility Tools) expose interfaces through the .NET Framework that you can use to implement components used in Relativity applications and hosted on the Relativity platform.
  - Headings: H1: Extending Relativity | H2: Extensibility Points | H2: User Interface Customization APIs | H2: Extending Relativity vs. Integrating with Relativity


### Extensibility
- [Event Handler Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Event_Handler_Manager_API.htm): Use the .NET Event Handler Manager API to attach event handlers to and detach them from object types, and to list available and attached handlers.
  - Second paragraph: The Event Handler Manager service contains methods for programmatically attaching event handlers to an object type, and for detaching them. It also provides helper methods that you can use for the following purposes:
  - Headings: H1: Event Handler Manager (.NET) | H2: Fundamentals for managing object event handlers | H2: Attach an event handler to an object type | H2: Detach an event handler to an object type | H2: Retrieve event handlers attached to an object type | H2: Retrieve available event handlers for an object type

- [Event Handler Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Event_Handler_Manager_service.htm): Use the Event Handler Manager REST service to attach event handlers to and detach them from object types, with Postman sample files and a client code sample.
  - Second paragraph: The Event Handler Manager service contains an endpoints for programmatically attaching event handlers to an object type, and for detaching them. It also provides helper endpoints that you can use for the following purposes:
  - Headings: H1: Event Handler Manager (REST) | H2: Postman sample files | H2: Client code sample | H2: Attach an event handler to an object type | H2: Detach an event handler from an object type | H2: Retrieve  event handlers attached to an object type | H2: Retrieve available event handlers for an object type

- [Extensibility .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/ExtensibilityNETAPI.html): Extensibility .NET API Reference

- [Extensibility .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Extensibility_NET_API_Reference.htm): Browse the .NET API reference for the Extensibility business domain, provided in the Relativity.Extensibility.SDK.
  - Headings: H1: Extensibility .NET API Reference | H2: Relativity.Extensibility.SDK

- [Extensibility Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Extensibility.htm): Find the .NET and REST API content, version history, and release notes for the Extensibility business domain, including event handlers, mass operations, scripts, and search providers.
  - Headings: H1: Extensibility | H2: Current Extensibility API content | H2: Version History

- [Legacy Search Provider Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_Manager_API.htm): Use the .NET Legacy Search Provider Manager to retrieve active search providers in a workspace and the HTML markup used to display them in the Relativity UI.
  - Second paragraph: It also returns the HTML markup used to display the search provider in the UI.
  - Headings: H1: Legacy Search Provider Manager (.NET) | H2: Search provider fundamentals | H2: Retrieve search providers

- [Legacy Search Provider Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_Manager_service.htm): Use the Legacy Search Provider Manager REST service to retrieve active search providers in a workspace and the HTML markup used to display them in the Relativity UI.
  - Second paragraph: The service returns search providers for a given workspace based on the  Artifact Type for a Relativity object that you define in the query. For example, you might specify the value for Artifact Type identifier associated with Document or Field objects.
  - Headings: H1: Legacy Search Provider Manager (REST) | H2: Client code sample | H2: Read a SearchProvider

- [Mass Operation Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Mass_Operation_Manager_API.htm): Use the .NET Mass Operation Manager API to create, read, update, and delete mass operations on object types, and to retrieve eligible object types, event handlers, and layouts.
  - Second paragraph: The Mass Operations Manager API includes methods for creating, reading, updating, and deleting mass operations. It also includes helper methods for retrieving information about object types that be associated with a mass operation, and available event handlers and layouts for use with a mass operation.
  - Headings: H1: Mass Operation Manager (.NET) | H2: Fundamentals for managing mass operations | H3: Methods | H3: Classes | H2: Guidelines for managing mass operations | H2: Create a mass operation | H2: Read a mass operation | H2: Update a mass operation | H2: Delete a mass operation | H2: Retrieve available object types for a mass operation | H2: Retrieve available event handlers for a mass operation | H2: Retrieve available layouts for a mass operation

- [Mass Operation Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Mass_Operation_Manager_service.htm): Use the Mass Operation Manager REST service to create, read, update, and delete mass operations on object types, with Postman sample files and a client code sample.
  - Second paragraph: The Mass Operation Manager service includes endpoints for creating, reading, updating, and deleting mass operations. It also includes helper endpoints for retrieving information about object types that be associated with a mass operation, and available event handlers and layouts for use with mass operations.
  - Headings: H1: Mass Operation Manager (REST) | H2: Postman sample files | H2: Client code sample | H2: Fundamentals for Mass Operation Manager | H2: Create a mass operation | H2: Read a mass operation | H2: Update a mass operation | H2: Delete a mass operation | H2: Retrieve available object types for a mass operation | H2: Retrieve available event handlers for a mass operation | H2: Retrieve available layouts for a mass operation

- [Script Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Script_Manager_API.htm): Use the .NET Script Manager API to create and manage SQL scripts, retrieve and preview input parameters, import scripts, and run script jobs.
  - Second paragraph: The Relativity Script Manager API exposes methods for interacting with scripts as follows:
  - Headings: H1: Script Manager (.NET) | H2: Script Manager API fundamentals | H3: Key concepts | H3: Troubleshooting information | H2: Add a script | H2: Retrieve script metadata | H2: Modify a script | H2: Delete a script | H2: Import a script | H2: Retrieve script input parameters | H2: Preview a script | H2: Queue a script to run | H2: Retrieve status of a script run job | H2: Query action results | H2: Export action results | H2: Export script report | H2: Clean up script results

- [Script Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Script_Manager_service.htm): Use the Script Manager REST service to create and manage SQL scripts, retrieve and preview input parameters, import scripts, and run script jobs.
  - Second paragraph: The Relativity Script Manager API service exposes endpoints for interacting with scripts as follows:
  - Headings: H1: Script Manager (REST) | H2: Postman sample file | H2: Guidelines for the Script Manager service | H3: URLs | H2: Client code sample | H2: Create a script | H2: Read a script | H2: Update a script | H2: Delete a script | H2: Import a script | H2: Get script parameters | H2: Preview a script body and input values | H2: Run script jobs and reports | H3: Enqueue run job | H3: Read run job | H3: Query action job results | H3: Export action results | H3: Export script report | H3: Clean up run job

- [Search Provider (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_API.htm): Use the .NET Search Provider API to create, read, update, and delete search providers in a workspace through the ISearchProviderManager interface.
  - Second paragraph: The Search Provider API service provides an API for the developers to interact with these Search Providers programmatically.
  - Headings: H1: Search Provider (.NET) | H2: Fundamentals for managing search providers | H3: Methods | H2: Create a search provider | H2: Update a search provider | H2: Retrieve search provider metadata | H2: Delete a search provider | H2: Retrieve a list of dependencies

- [Search Provider (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_service_in_REST.htm): Use the Search Provider REST service to create and manage search providers in a workspace, such as keyword, dtSearch, and Analytics providers.
  - Second paragraph: The Search Provider API service provides an API for the developers to interact with these Search Providers programmatically.
  - Headings: H1: Search Provider (REST) | H2: Create a search provider | H2: Update a search provider | H2: Retrieve search provider metadata | H2: Delete a search provider | H2: Retrieve a list of dependencies


### FormsAPI
- [Action Bar Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Action_Bar_Api.htm): Provides methods for creating and updating action bars. These functions are available under the `convenienceApi.actionBar` namespace.
  - Second paragraph: A collection of functions that are capable of generating elements used by the action bar with preset defaults
  - Headings: H1: Action Bar Api | H2: Properties | H2: Methods | H2: Properties Details | H3: generate | H3: generateDefault | H3: isVisible : Boolean | H3: isVisible | H3: defaultActions | H3: createDefaultActionBar() ⇒ Promise | H3: destroy() ⇒ Promise

- [Additional Data Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Additional_Data_Api.htm): Provides a method for retrieving additional data. These functions are available under the `convenienceApi.additionalData` namespace.
  - Second paragraph: Gets field and function pairs which creates additional data promises.
  - Headings: H1: Additional Data Api | H2: Methods | H2: Properties Details | H3: getDefaultFactoriesForAdditionalData(workspaceId, fieldsRequiringAdditionalData) ⇒ Array.<Object>

- [Application Paths] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Application_Paths.htm): Represents an object used to supply application paths specific to Relativity. These functions are available under the `convenienceApi.applicationPaths` namespace.
  - Second paragraph: Specifies the Base URL for the Relativity application
  - Headings: H1: Application Paths | H2: Properties Details | H3: relativity : String | H3: kepler : String | H3: relativityRest : String

- [Change Pipeline] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Change_Pipeline.htm): The Change pipeline includes event handlers that you can use to customize user interaction with form fields and to develop your own validation logic for individual fields or the entire form. For example, you might implement an event handler that validates an integer field is even.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Change Pipeline | H2: Change pipeline workflow | H3: Change pipeline event handlers | H3: Ambient variables | H3: pageInteraction | H3: validation

- [ColumnsApi] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ColumnsApi.htm): API exposed in ITEM_LIST_MODIFY_COLUMNS event handler to modify columns metadata.
  - Second paragraph: Sets custom formatter with the specified format action for the column.
  - Headings: H1: ColumnsApi | H2: Methods | H2: Properties Details | H3: setCustomFormatter(columnName, formatterAction) ⇒ undefined | H3: setFilterDataSource(columnName, filterDataSource) ⇒ undefined | H3: setLinkFormatter(columnName, options) ⇒ undefined | H3: removeColumn(columnName) ⇒ undefined | H3: setColumnTitle(columnName, title) ⇒ undefined

- [Console Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Console_Api.htm): Provides methods for creating a console on a page. These functions are available under the `convenienceApi.console` namespace.
  - Second paragraph: Contains a reference to the console root element container.
  - Headings: H1: Console Api | H2: Properties | H2: Methods | H2: Properties Details | H3: containersPromise ⇒ Promise | H3: generate | H3: isVisible ⇒ Boolean | H3: isVisible | H3: destroy() ⇒ Promise

- [Constants Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Constants_Api.htm): Provides access to certain constants used globally in an application. These constants are available under the `convenienceApi.constants` namespace.
  - Second paragraph: Enum of actions used in item list.
  - Headings: H1: Constants Api | H2: Properties Details | H3: ACTION_TYPES : Object.<String, String> | H3: ACTION_THEMES : Object.<String, String> | H3: ACTIONS : Object.<String, String> | H3: ADMIN_WORKSPACE_ARTIFACT_ID : Number | H3: ARTIFACT_TYPE : Object.<String, Number> | H3: DISPLAYABLE_OBJECT_IDENTIFIER : Object.<String, String> | H3: EVENT_TYPE : Object.<String, Number> | H3: FORM_VIEW_MODEL_TYPE : Object.<String, Number> | H3: MESSAGE_CONTAINER_THEMES : Object.<String, String> | H3: MODAL_CLASSES : Object.<String, String> | H3: NAME_ID_PAIR : Object.<String, String> | H3: OBJECT_TYPE_IDENTIFIER : Object.<String, String> | H3: PERMISSION_ID : Object.<String, Number> | H3: PERMISSION_TYPE : Object.<String, Number> | H3: SELECTION_TYPE : Object.<String, String> | H3: VIEW_MODEL_NAME : Object.<String, String> | H3: SAVE_OPERATIONS : Object.<String, Number> | H3: KEYS : Array.<Object> | H3: HTTP_STATUS_CODE : Object.<String, Number> | H3: ITEM_LIST_COMMAND_COLUMN_TYPE : Object.<String, (String|null)>

- [ConvenienceAPI] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ConvenienceAPI.htm): An instance of the Convenience API
  - Second paragraph: Includes methods for creating and updating the contents of an action bar.
  - Headings: H1: ConvenienceAPI | H2: Properties Details | H3: Action Bar | H3: Additional Data | H3: Application Paths | H3: Console | H3: Constants | H3: Field | H3: Date Time | H3: File Field | H3: Item List Data Provider Factory | H3: Item List Helper | H3: I18n | H3: Layout | H3: Log Factory | H3: Modal Service | H3: Model Transformer | H3: Navigation | H3: Permission | H3: Popup Service | H3: Preview Security | H3: Promise Factory | H3: Relativity Forms Popup | H3: Static Text Helper | H3: Get Current Form State | H3: Relativity HTTP Client | H3: Review Queue Browser | H3: User | H3: Utilities | H3: Validation

- [Date Time Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Date_Time_Api.htm): Represents a date-time value formatter. This API is part of the data-management modules within the Relativity web components library, which is made directly available via the convenienceApi. These functions are available under the `convenienceApi.dateTime` namespace.
  - Second paragraph: Returns a formatter object that can be used to format date-time strings to a given locale
  - Headings: H1: Date Time Api | H2: Methods | H2: Properties Details | H3: getFormatter(options) ⇒ Object

- [Delete Pipeline] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Delete_Pipeline.htm): The Delete pipeline includes event handlers that control the process for removing objects from Relativity. It contains an event handler that retrieves a list of objects dependent on the item or items selected for deletion. In addition, it provides you with the option to implement an event handler with custom logic for deletion, or to use the standard event handler for this operation provided in Relativity. For example, you might want to implement a custom event handler that adds additional items to the delete dependency list of the selected items to be deleted.
  - Second paragraph: Note: The Delete pipeline initiates when any of the following actions take place:
  - Headings: H1: Delete Pipeline | H2: Delete pipeline workflow | H3: Delete pipeline event handlers | H3: Ambient variables | H3: replaceReadDeleteDependencyList | H3: preDelete | H3: replaceDelete | H3: postDelete

- [Field Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Field_Api.htm): Includes methods for quickly accessing and modifying fields. This API will not work properly until the hydrateLayoutComplete stage or later. These functions are available under the convenienceApi.fieldHelper namespace.
  - Second paragraph: Gets the field value of a given field from the view model.
  - Headings: H1: Field Api | H2: Methods | H2: Properties Details | H3: getValue(identifier) ⇒ Promise.<(Object|null)> | H3: getHtmlElement(identifier) ⇒ Promise.<(HTMLelement|null)> | H3: setIsEditMode(identifier, isEditMode) ⇒ Promise.<(Boolean|null)> | H3: setIsDisabled(identifier, isDisabled) ⇒ Promise.<(Boolean|null)> | H3: setIsLoading(identifier, isLoading) ⇒ Promise.<(undefined|null)> | H3: setContextualHelpText(identifier, [contextualHelpText]) ⇒ Promise.<(undefined|null)> | H3: addAdditionalData(identifier, additionalData) ⇒ Promise.<(undefined|null)> | H3: setIsHidden(identifier, isHidden) ⇒ Promise.<(Boolean|null)> | H3: setIsRequired(identifier, isRequired) ⇒ Promise.<(Boolean|null)> | H3: setValue(identifier, valueToSet) ⇒ Promise.<(Object|null)> | H3: setAriaDescribedby(identifier, ariaDescribedby) ⇒ Promise.<(String|null)>

- [File Field Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/File_Field_Api.htm): An api for file management. These functions are available under the `convenienceApi.fileField` namespace.
  - Second paragraph: Downloads file from specified field.
  - Headings: H1: File Field Api | H2: Methods | H2: Properties Details | H3: downloadFile(workspaceId, artifactId, fieldId, fileName) ⇒ undefined | H3: uploadFile(workspaceId, artifactId, fieldId, file, backendProgressCallback, frontendProgressCallback, cancellationToken) ⇒ Promise

- [Form Settings Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Form_Settings_Api.htm): Represents an object that contains general settings related to the user viewing a form and the artifact displayed in it. These functions are available under the `convenienceApi.formSettings` namespace.
  - Second paragraph: Returns all the form settings for the application.
  - Headings: H1: Form Settings Api | H2: Methods | H2: Type Definitions | H2: Properties Details | H3: getFormSettings() ⇒ | H3: FormSettings

- [GetCurrentFormState] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/GetCurrentFormState.htm): An API exposed to retrieve the current state of the view model for the form. A method available under `convenienceApi` that is provided to retrieve the current state of the view model for the form.
  - Second paragraph: Returns a copy of the current view-model.
  - Headings: H1: GetCurrentFormState | H2: Methods | H2: Properties Details | H3: getCurrentFormState() ⇒ FormViewModel

- [i18n] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/i18n.htm): Helper methods to support internationalization of message text. These functions are available under the `convenienceApi.i18n` namespace.
  - Second paragraph: Looks up a key and returns the localized string for the current locale.
  - Headings: H1: i18n | H2: Methods | H2: Properties Details | H3: tr(key) ⇒ String | H3: getLocale() ⇒ String | H3: nf(options, lang) ⇒ Intl.NumberFormat | H3: df(options, lang) ⇒ Intl.DateTimeFormat | H3: addResources(lang, resources) ⇒ undefined

- [Item list event handlers] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Item_list_event_handlers.htm): The Relativity Forms API includes event handlers and classes used to manipulate item lists.
  - Second paragraph: The following table lists the item list event handlers.
  - Headings: H1: Item list event handlers | H3: Summary of item list event handlers | H3: Summary of item list event handler APIs and objects | H2: Item List Event Handlers | H3: itemListModifyActions | H3: itemListModifyColumns | H3: itemListReloaded | H2: Item list APIs and Related Objects | H3: Item List Action button object | H3: View object | H3: Visibility Rule class

- [ItemList Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ItemList_Api.htm): Includes methods for quickly accessing and modifying item lists. This API doesn't function properly until the hydrateLayoutComplete stage or later. These functions are available under the `convenienceApi.itemListHelper` namespace.
  - Second paragraph: Sets the ITEM_LIST_COMMAND_COLUMN_TYPE for the item list idenfitied by identifier to commandColumnType
  - Headings: H1: ItemList Api | H2: Methods | H2: Properties Details | H3: setCommandColumnType(itemListIdentifier, commandColumnType) ⇒ Promise.<(undefined|null)>

- [itemListActionsApi] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/itemListActionsApi.htm): Modifies action buttons on the item list. The itemListActionsApi is exposed as a part of the event handler API.
  - Second paragraph: Initializes an empty collection of action buttons.
  - Headings: H1: itemListActionsApi | H2: Methods | H2: Properties Details | H3: initialize() ⇒ undefined | H3: areActionsInitialized() ⇒ Boolean | H3: getActions() ⇒  | null | H3: addDefaultActions() ⇒ undefined | H3: addAction(actionType, clickHandler, options) ⇒  | null | H3: removeActions(...actionTypes) ⇒ undefined | H3: differentiateActionsByItemListType() ⇒ undefined | H3: getGlobalVisibilityRules() ⇒ Object | null | H3: getSublistVisibilityRules() ⇒ Object | null | H3: checkActionsByVisibilityRules() ⇒ undefined | H3: checkPermissions() ⇒ Promise | H3: checkRulesAndPermissions() ⇒ Promise | H3: setCustomGetDataFunction(getDataFunction) ⇒ undefined

- [ItemListDataProviderFactory] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ItemListDataProviderFactory.htm): Factory of Item List Data Providers. Creates data providers based on a given type. These functions are available under the `convenienceApi.itemListDataProviderFactory` namespace.
  - Second paragraph: Creates an instance of the data provider based on a given type.
  - Headings: H1: ItemListDataProviderFactory | H2: Methods | H2: Properties Details | H3: create(providerType, options) ⇒ Object

- [Layout Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Layout_Api.htm): API exposed that can be used to help parse and manipulate a given layoutData. These functions are available under the `convenienceApi.layout` namespace.
  - Second paragraph: Removes a given field by id from the layout
  - Headings: H1: Layout Api | H2: Methods | H2: Properties Details | H3: removeFieldFromLayout(layoutData, id) ⇒ Object | null | H3: getFields(layoutData) ⇒ Array.<Object> | H3: getItemLists(layoutData) ⇒ Array.<Object> | H3: getCustomTexts(layoutData) ⇒ Array.<Object> | H3: getCategories(layoutData) ⇒ Array.<Object>

- [Layout representation for Relativity forms] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Layout_representation_for_Relativity_forms.htm): The Relativity Forms API supports a specific layout structure for forms that enables client-side event handlers to interact with different components. This page contains an overview of the layout structure and highlights different components in it.
  - Second paragraph: The following diagram illustrates the layout structure for forms supported by the Relativity Forms API.
  - Headings: H1: Layout representation for Relativity forms | H2: Layout structure overview | H2: Summary of Layout components | H2: JSON data contracts | H3: Group | H3: Category | H3: Field | H3: CustomText | H3: ItemList | H3: View | H3: ViewField

- [Load Pipeline] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Load_Pipeline.htm): In the Relativity Forms API, the Load pipeline represents what happens during page loads. This includes full loads and partial reloads caused by layout or object switches. The Load pipeline offers the ability to customize and extend its behaviors by implementing any of the pipeline's event handlers within the JavaScript for your Relativity Forms Page Interaction event handler. For example, overriding the replaceGetNewObjectInstance event handler would allow the definition of default values for new object instances to display within a form.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Load Pipeline | H2: Load pipeline workflow | H2: Load pipeline event handlers | H2: Ambient variables | H2: eventHandlersRegistered | H3: Syntax | H3: Parameters | H2: replaceRead | H3: Syntax | H3: Parameters | H3: Returns | H3: Syntax | H2: replaceGetNewObjectInstance | H3: Syntax | H3: Parameters | H2: transformLayout | H3: Syntax | H3: Parameters | H2: hydrateLayout | H3: Syntax | H3: Parameters | H2: hydrateLayoutComplete | H3: Syntax | H3: Parameters | H2: overridePickerDataSource | H3: Syntax | H3: Parameters | H3: The PickerDataSource object | H3: Parameters | H3: Return Value | H3: Examples | H3: Customizing the stock Data Provider | H2: replaceFileActions | H3: Syntax | H3: Parameters | H2: Parameters | H2: BackendProgressPayload | H2: BackendProgressMessage | H2: Sample Usage | H2: Sample Usage (XMLHttpRequest) | H2: Sample Usage (custom http client) | H2: Example | H2: Returns | H2: Example | H2: Parameters | H2: Returns | H2: Example | H2: replaceObtainAdditionalData | H2: Example | H2: Parameters | H2: Output | H3: The AdditionalData object | H3: If AdditionalData is an Array<Option> | H3: If AdditionalData is an Object | H3: The Option Object | H2: postObtainAdditionalData | H3: Syntax | H3: Parameters | H2: createActionBar | H3: Example | H3: Parameters | H3: Returns | H2: updateActionBar | H3: Syntax | H3: Parmaters | H3: Returns | H2: createConsole | H3: Syntax | H3: Parameters | H3: Returns | H2: updateConsole | H3: Example | H3: Parameters | H3: Returns | H2: pageLoadComplete | H3: Example | H3: Parameters

- [Log Factory] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Log_Factory.htm): Provides a collection of functions that can be used to create loggers. These functions are available under the `convenienceApi.logFactory` namespace.
  - Second paragraph: Returns an instance of a logger. This logger contains methods to facilitate logging, including debug, warn, and error.
  - Headings: H1: Log Factory | H2: Methods | H2: Properties Details | H3: getLogger(id) ⇒ Logger

- [Modal Service] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Modal_Service.htm): Helper methods to open different types of modals. These functions are available under the `convenienceApi.modalService` namespace.
  - Second paragraph: Open a confirmation modal
  - Headings: H1: Modal Service | H2: Methods | H2: Properties Details | H3: confirm(model, openModalHandler) ⇒ Promise | H3: openProgressModal(model, openModalHandler) ⇒ Promise | H3: openCustomModal(model, openModalHandler) ⇒ Promise | H3: openDeleteModal(model, openModalHandler) ⇒ Promise | H3: openMultiListPickerModal(model, openModalHandler) ⇒ Promise | H3: openSingleListPickerModal(model, openModalHandler) ⇒ Promise | H3: openKeyboardShortcutModal(model, openModalHandler) ⇒ Promise

- [Model Transformer Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Model_Transformer_Api.htm): API used for dto and model data transformations.
  - Second paragraph: A collection of default transformers.
  - Headings: H1: Model Transformer Api | H2: Properties | H2: Methods | H2: Properties Details | H3: defaultTransformers | H3: transformInbound(rules, dto) ⇒ Object | H3: transformOutbound(rules, modelData) ⇒ Object

- [Navigation Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Navigation_Api.htm): Helper methods for navigation. These functions are available under the `convenienceApi.navigation` namespace.
  - Second paragraph: Attempts to navigate to a specific artifact
  - Headings: H1: Navigation Api | H2: Methods | H2: Properties Details | H3: navigateToArtifactId(requestedArtifactId, options) ⇒ Promise | H3: switchLayout(requestedLayoutId, options) ⇒ Promise | H3: navigateToForm(viewModelName, params, routerOptions, navigationOptions) ⇒ Promise

- [Permission Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Permission_Api.htm): Represents a permission object exposed as a part of the Event Handler API. It is used to check actions allowed for an object of a specific object type in a given workspace. These functions are available under the `convenienceApi.permission` namespace.
  - Second paragraph: Returns user's permission to view object
  - Headings: H1: Permission Api | H2: Methods | H2: Properties Details | H3: canView() ⇒ Boolean | undefined | H3: canEdit() ⇒ Boolean | undefined | H3: canDelete() ⇒ Boolean | undefined | H3: canSecure() ⇒ Boolean | undefined | H3: canAdd() ⇒ Boolean | undefined | H3: canViewAudit() ⇒ Boolean | undefined

- [Popup Service Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Popup_Service_Api.htm): Provides a service used to open pop-up windows. These functions are available under the `convenienceApi.popupService` namespace.
  - Second paragraph: Open a popup given options
  - Headings: H1: Popup Service Api | H2: Methods | H2: Properties Details | H3: open(url, title, options) ⇒ Window | null

- [Preview Security Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Preview_Security_Api.htm): Provides a collection of methods for utilizing Preview Security mode. For more information, see Preview security on the Relativity Documentation site. These functions are available under the `convenienceApi.previewSecurity` namespace.
  - Second paragraph: Opens Preview Security mode for particular group.
  - Headings: H1: Preview Security Api | H2: Methods | H2: Properties Details | H3: openForGroup(groupArtifactId) ⇒ undefined

- [Promise Factory] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Promise_Factory.htm): Provides a factory containing methods for returning promises. These functions are available under the `convenienceApi.promiseFactory` namespace.
  - Second paragraph: Returns a promise that is resolved with a specific value. For more information, see Promise.resolve() on the MDN web docs site.
  - Headings: H1: Promise Factory | H2: Methods | H2: Properties Details | H3: resolve() ⇒ Promise | H3: reject() ⇒ Promise | H3: all() ⇒ Promise

- [Relativity Forms Popup Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Relativity_Forms_Popup_Api.htm): Includes methods for creating pop-up windows running the Relativity Forms API. These functions are available under the `convenienceApi.relativityFormsPopup` namespace.
  - Second paragraph: Open a Relativity Forms popup in add mode
  - Headings: H1: Relativity Forms Popup Api | H2: Methods | H2: Properties Details | H3: openAdd(config) ⇒ Object | H3: openEdit(config) ⇒ Object | H3: openView(config) ⇒ Object

- [RelativityHTTPClient] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/RelativityHTTPClient.htm): An API exposed to get access to a REST client for making http requests. These functions are available under the `convenienceApi.relativityHttpClient` namespace.
  - Second paragraph: Makes an HTTP DELETE request to the specified URL.
  - Headings: H1: RelativityHTTPClient | H2: Methods | H2: Properties Details | H3: delete(url, requestOptions) ⇒ Promise | H3: get(url, requestOptions) ⇒ Promise | H3: post(url, payload, requestOptions) ⇒ Promise | H3: put(url, payload, requestOptions) ⇒ Promise | H3: makeRelativityRelativeUrl(url) ⇒ String | H3: makeRelativityBaseRequestOptions(extendWith) ⇒ Object | H3: makeRelativityRestRelativeUrl(url) ⇒ String | H3: makeRelativityRestBaseRequestOptions(extendWith) ⇒ Object

- [Review Queue Browser Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Review_Queue_Browser_Api.htm): Provides functionality similar to the navigational controls on the page. These functions are available under the `convenienceApi.reviewQueueBrowser` namespace.
  - Second paragraph: Public API for review queue browsing. Supports the following functions:
  - Headings: H1: Review Queue Browser Api | H2: Properties | H2: Properties Details | H3: navigate | H3: currentQueueIndex : Number | H3: reviewQueueInformation : Object

- [Static Text Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Static_Text_Api.htm): API exposed in all event handlers that can be used to communicate with Static Text components in the view. These functions are available under the `convenienceApi.staticTextHelper` namespace.
  - Second paragraph: Returns an array of Static Text component view-models.
  - Headings: H1: Static Text Api | H2: Methods | H2: Properties Details | H3: retrieveAll() ⇒ Array.<Promise.<Object>> | null | H3: getValue(staticTextId) ⇒ Promise.<(String|null)> | H3: getHtmlElement(staticTextId) ⇒ Promise.<(Object|null)> | H3: setIsHidden(staticTextId, isHidden) ⇒ Promise.<(Boolean|null)> | H3: setValue(staticTextId, value) ⇒ Promise.<(String|null)>

- [Submit Pipeline] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Submit_Pipeline.htm): The Submit pipeline includes event handlers that control the workflow for saving changes to a form. It contains two event handlers for handling validation: one that executes when the form is updated, and another that executes before the form is saved to Relativity. Additionally, you have the option to implement an event handler that uses custom logic for saving data or to use the standard event handler for this operation provided in Relativity.
  - Second paragraph: For example, you might want to implement a custom event handler that performs custom validation of the data before it saves or performs cleanup after the data is saved.
  - Headings: H1: Submit Pipeline | H2: Submit pipeline workflow | H2: Submit pipeline event handlers | H2: Ambient variables | H2: preSave | H2: Syntax | H2: Parameters | H2: validation (on submit) | H2: Syntax | H2: Parameters | H2: Validation example | H2: replaceSave | H2: Syntax | H2: Parameters | H2: Example | H2: validateSave | H2: Syntax | H2: Parameters | H2: Example | H2: Example Error Message Output | H2: postSave | H2: Syntax | H2: Parameters | H2: pageUnload | H2: Syntax | H2: Parameters | H2: Example

- [The this binding] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/The_this_binding.htm): Helper methods and properties used to interact with the form's viewModel within an event handler via the "this" keyword.
  - Second paragraph: Gets artifact ID. The artifact identifier of the viewModel available for View and Edit modes only.
  - Headings: H1: The this binding | H2: Properties | H2: Methods | H2: Properties Details | H3: artifactId ⇒ Number | Null | H3: artifactTypeId ⇒ Number | Null | H3: associatedArtifactId ⇒ Number | Null | H3: backingModelData ⇒ Object | H3: connectorFieldArtifactId ⇒ Number | Null | H3: exitDialog ⇒ Object | H3: fieldGuidToFieldIdMap ⇒ Object | H3: fieldNameToFieldIdMap ⇒ Map | H3: formViewModelTypeId ⇒ Number | H3: isDirty ⇒ Boolean | H3: isNew ⇒ Boolean | H3: lastVisitedArtifactId ⇒ Number | H3: layoutId ⇒ Number | H3: layoutMetadataCopy ⇒ Object | H3: parentArtifactId ⇒ Number | H3: viewModelName ⇒ String | H3: volatileModelData ⇒ Object | H3: workspaceId ⇒ Number | H3: clearErrorSummary() ⇒ undefined | H3: clearModelData() ⇒ undefined | H3: getFieldIdForField() ⇒ Number | H3: handleApplicationError(error) ⇒ undefined | H3: handlePermissionDeniedError() ⇒ undefined | H3: refreshLayout() ⇒ undefined | H3: setErrorSummary(messages, expand) ⇒ undefined

- [User Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/User_Api.htm): Provides properties and methods related to a user. These functions are available under the `convenienceApi.user` namespace.
  - Second paragraph: Retrieves current acl user id
  - Headings: H1: User Api | H2: Methods | H2: Properties Details | H3: getCurrentAclUserId(workspaceId) ⇒ Promise

- [Utility Function Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Utility_Function_Api.htm): An API exposed that gives access to various utility functions. These functions are available under the `convenienceApi.utilities` namespace.
  - Second paragraph: Convert an array of name value pairs into a array with values for given key.
  - Headings: H1: Utility Function Api | H2: Methods | H2: Properties Details | H3: keyValueArrayToJsonArrayTransformer(arrayToTransform, inputValueKey) ⇒ Array | H3: getHtmlEventTarget(htmlEvent) ⇒ Object | null | H3: reload() ⇒ undefined | H3: createKeyValuePair(key, value) ⇒ Object | H3: getMainKeyCharCode(keys, charName) ⇒ Number | H3: getMainKeyFromCharCode(keys, charCode) ⇒ String | H3: escapeString(string) ⇒ String | H3: unescapeString(string) ⇒ String | H3: sanitizeHtmlString(string) ⇒ String | H3: getRelativityPageBaseWindow() ⇒ Object

- [Validation Api] (https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Validation_Api.htm): Represents an object used to facilitate the form validation process by creating data structures required by the validationArray. These functions are available under the `convenienceApi.validation` namespace.
  - Second paragraph: Get a validation object scoped to the summary with the given failure message
  - Headings: H1: Validation Api | H2: Methods | H2: Properties Details | H3: getFailedSummaryObject(validationMessage) ⇒ Object | H3: getFailedFieldObject(fieldId, validationMessage) ⇒ Object | H3: getDefaultSummaryErrorForAction(actionName) ⇒ String | H3: getSilentFailureObject() ⇒ Object | H3: validateSaveResult(response, validationArray, options) ⇒ Promise.<Object> | H3: isValidInteger32(value) ⇒ Boolean | H3: isValidNonNegativeInteger32(value) ⇒ Boolean | H3: isValidPositiveInteger32(value) ⇒ Boolean | H3: isValidInteger64(value) ⇒ Boolean | H3: isValidNonNegativeInteger64(value) ⇒ Boolean | H3: isValidPositiveInteger64(value) ⇒ Boolean


### Get started
- [Building applications 101] (https://platform.relativity.com/RelativityaiR/Content/Get_started/Building_applications_101.htm): Find the moved Building applications 101 lessons, from setting up your developer environment through building a cron job, a custom page, and Relativity Forms UI enhancements.

- [Lesson 1 - Set up your developer environment] (https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_1_-_Set_up_your_developer_environment.htm): Lesson 1 of the Get started series on setting up your Relativity developer environment. This topic has moved to a new location.

- [Lesson 2 - Build an application without any code] (https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_2_-_Build_an_application_without_any_code.htm): Lesson 2 of the Get started series on building a Relativity application without any code. This topic has moved to a new location.

- [Lesson 3 - Create a RESTful API] (https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_3_-_Create_a_RESTful_API.htm): Lesson 3 of the Get started series on creating a RESTful API for Relativity. This topic has moved to a new location.

- [Lesson 4 - Validate object changes] (https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_4_-_Validate_object_changes.htm): Lesson 4 of the Get started series on validating object changes in Relativity. This topic has moved to a new location.

- [Lesson 5 - Build a cron job] (https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_5_-_Build_a_cron_job.htm): Lesson 5 of the Get started series on building a cron job in Relativity. This topic has moved to a new location.

- [Lesson 6 - Create a custom page] (https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_6_-_Create_a_custom_page.htm): Lesson 6 of the Get started series on creating a Relativity custom page. This topic has moved to a new location.

- [Lesson 7 - Use Relativity Forms to enhance the UI] (https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_7_-_Use_Relativity_Forms_to_enhance_the_UI.htm): Lesson 7 of the Get started series on using Relativity Forms to enhance the UI. This topic has moved to a new location.


### Get started RelativityOne
- [Build a custom page] (https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Create_a_custom_page.htm): This tutorial illustrates how to create a simple custom page without using Visual Studio templates
  - Second paragraph: In this lesson, you will learn how to complete these tasks:
  - Headings: H1: Lesson 5 - Create a custom page | H2: Step 1 - Create a simple custom page | H2: Step 2 - Deploy a custom page in Relativity | H2: Step 3 - Add client-side JavaScript to a custom page | H2: Step 4 - Debug your custom page | H2: Step 5 - Implement functionality for your custom page | H2: Step 6 - Add tests for your custom page logic | H2: Step 7 - Make your custom page production ready

- [Learn about Relativity development] (https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Advanced_Tutorials.htm): Follow these lessons to build your first Relativity application by integrating with Relativity APIs, and learn who the tutorial series is designed for.
  - Second paragraph: These tutorials are based on using a Relativity aiR Sandbox environment.
  - Headings: H1: Learn about Relativity development | H2: Audience for this tutorial | H2: How to complete the tutorial | H2: Estimated completion time | H2: Considerations

- [Lesson 1 - Build an application without any code] (https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Build_an_application_without_any_code.htm): Follow Lesson 1 to create a workspace, build a Relativity application without writing code, and export it as a RAP file for use in another workspace.
  - Second paragraph: In this lesson, you will learn how to complete these tasks:
  - Headings: H1: Lesson 1 - Build an application without any code | H2: Step 1 - Create a new workspace through the Relativity UI | H2: Step 2 - Create an application in the workspace | H2: Step 3 - Create object types for your application | H2: Step 4 - Create fields for the application | H2: Step 5 - Update layouts to include fields for the application | H2: Step 6 - Update views to include fields for the application | H2: Step 7 - Set up tabs for the application | H2: Step 8 - Add sample data through the Relativity UI | H2: Step 9 - Create a dashboard | H2: Step 10 - Finalize and export application | H2: Step 11 - Install the application in a workspace | H2: Step 12 - Verify that the application built

- [Lesson 2 - Create a RESTful API] (https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Create_a_RESTful_API.htm): Follow Lesson 2 to use the Kepler framework to build a RESTful API that integrates with Wikipedia
  - Second paragraph: In this lesson, you will learn how to:
  - Headings: H1: Lesson 2 - Create a RESTful API | H2: Step 1 - Create an empty Kepler service | H2: Step 2 - Deploy to Relativity | H2: Step 3 - Test the deployed service | H2: Step 4 - Update the service | H2: Step 5 - Implement methods on an interface | H2: Step 6 - Write a unit test | H2: Step 7 - Deploy and verify

- [Lesson 3 - Validate object changes] (https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Validate_object_changes.htm): Follow Lesson 3 to create a Relativity Dynamic Object and implement a Pre Save event handler that validates data using the MediaWiki API and Object Manager API.
  - Second paragraph: Event handlers manipulate or validate data that users see or modify through the Relativity UI.
  - Headings: H1: Lesson 3 - Validate object changes | H2: Step 1 - Implement a Pre Save event handler | H2: Step 2 - Upload the event handler assembly to Relativity | H2: Step 3 - Add validation logic to an event handler | H2: Step 4 - Make service calls from the event handler | H2: Step 5 - Write unit tests

- [Lesson 4 - Build a cron job] (https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Build_a_cron_job.htm): Follow Lesson 4 to build a Relativity agent that runs on a set time interval and creates and updates documents using the Kepler service from the earlier lesson.
  - Second paragraph: In this lesson, you will learn how to complete these tasks:
  - Headings: H1: Lesson 4 - Build a cron job | H2: Step 1 - Create a basic agent | H2: Step 2 - Upload the agent to an application | H2: Step 3 - Update the agent functionality | H2: Step 4 - Write a unit test | H2: Step 5 - Verify that the agent runs

- [Lesson 6 - Use Relativity Forms to enhance the UI] (https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Use_Relativity_Forms_to_enhance_the_UI.htm): Follow Lesson 6 to use Relativity Forms and a PageInteractionEventHandler to customize a layout, changing checkbox fields to toggles in the Hello Wikipedia application.
  - Second paragraph: In this lesson, you will learn how to complete these tasks:
  - Headings: H1: Lesson 6 - Use Relativity Forms to enhance the UI | H2: Step 1 - Pre-work | H2: Step 2 - Set up the project folders and create an event handler in Visual Studio | H2: Step 3 - Create a JavaScript file for an event handler | H2: Step 4 - Associate the event handler with an object type | H2: Step 5 - Add functionality to the JavaScript event handler | H2: Step 6 - Test your JavaScript | H3: Configure your development machine | H3: Configure your project | H3: Add files for unit testing | H3: Add a unit test | H3: Run the unit test


### Getting Started
- [Basic REST API concepts] (https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Basic_REST_API_concepts.htm): Learn the basic parts of a Relativity REST call, including the URL host, REST surface, business domain and version, HTTP method, headers, body, and the tools used to test calls.
  - Second paragraph: You can easily test REST calls with tools like cURL, Postman, or ARC. These tools simplify setting headers and changing request bodies. They provide a quick way to test REST calls, so you can easily see the results of changing your request. In this tutorial, the screen shots are taken from Postman.
  - Headings: H1: Basic REST API concepts | H2: Tools | H2: URL | H2: Methods | H2: Headers | H2: Body | H2: Authentication | H2: Response | H2: Use Cases | H2: Troubleshooting

- [Basic Tutorials] (https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Basic_tutorials.htm): Find where the basic Relativity developer tutorials moved. This topic points to the Developer Tutorials content.
  - Headings: H1: Basic tutorials

- [Core Concepts for Developers] (https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Core_Concepts.htm): Landing page for core concepts you should know before developing with Relativity.
  - Headings: H1: Core concepts for developers

- [Export Service API builders] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Builders.htm): Use the builders in the Relativity.Export.SDK package to create export job, source, and artifact settings in a .NET application, with code samples for exporting natives, full text, images, and PDFs.
  - Second paragraph: The following code samples show how to create export job settings using builders to export native, fulltext, images, and PDF files from a folder.
  - Headings: H1: Export Service API builders | H2: Export Builders | H3: Export source settings | H3: Export Artifact settings | H3: Export Subdirectory settings | H3: Export job settings

- [Getting started] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Getting_Started.htm): Get started with the Export Service API, including the required applications, permissions, client packages, and authentication methods for HTTP and Kepler .NET clients.
  - Second paragraph: Please have the following actions completed before using the Export Service API:
  - Headings: H1: Getting started | H2: Prerequisites | H3: Authorization | H3: Permissions | H2: Make calls to export service | H3: HTTP clients | H3: Kepler .NET client

- [Getting started with the Import Service API] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Getting_Started.htm): Get started with the Import Service API, a Kepler service whose endpoints you call in sequence to run an import, including prerequisites, permissions, and required packages.
  - Second paragraph: Ensure the following Relativity applications are installed:
  - Headings: H1: Getting started with the Import Service API | H2: Prerequisites | H3: Authorization | H3: Permissions | H2: Make calls to import service | H3: HTTP clients | H3: Kepler .NET client | H3: Rate limit

- [Import data into RDOs] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Import_data_into_RDOs.htm): Use the Import Service API to import data programmatically into existing Relativity Dynamic Objects (RDOs), including creating and configuring the import job.
  - Second paragraph: On GitHub, you can find can comprehensive samples illustrating how to import native documents, images, objects, and productions. For additional code samples, see the Import API samples repository.
  - Headings: H1: Import data into RDOs | H2: Create import job | H2: Create import job configuration | H2: Add data source | H2: Begin import job | H2: End import job

- [Import documents] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Export_job.htm): Follow a code sample that configures and runs an Export Service API job to export native files from a folder, using builders to create the job configuration.
  - Second paragraph: On GitHub, you can find can comprehensive samples illustrating how to export native documents, images, objects, and productions. For additional code samples, see the Export API samples repository.
  - Headings: H1: Export job | H2: Create an export job configuration | H2: Create an export job | H2: Start an export job | H2: Check export job status | H3: Export Job States

- [Import documents] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Import_documents.htm): Use the Import Service API to add documents to a workspace programmatically, including load file path considerations and creating the import job.
  - Second paragraph: On GitHub, you can find can comprehensive samples illustrating how to import native documents, images, objects, and productions. For additional code samples, see the Import Service API samples repository.
  - Headings: H1: Import documents | H2: Considerations | H2: Create an import job | H2: Create an import job configuration | H2: Add data source | H2: Begin import job | H2: End import job

- [Import images] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Import_images.htm): Use the Import Service API to add images to Relativity programmatically, including creating and configuring the import job with curl and C# builder samples.
  - Second paragraph: On GitHub, you can find can comprehensive samples illustrating how to import native documents, images, objects, and productions. For additional code samples, see the Import Service API samples repository.
  - Headings: H1: Import images | H2: Create import job | H2: Create import job configuration | H2: Add data source | H2: Begin import job | H2: End import job

- [Import Service API builders] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Builders.htm): Use the builders in the Relativity.Import.Models.SDK package to create import settings for documents, RDOs, and data sources consistently in a .NET client application.
  - Second paragraph: The following code sample illustrates how to use the ImportRdoSettingsbuilderto create ImportRdoSettings. For more information, see Import data into RDOs.
  - Headings: H1: Import Service API builders | H2: ImportDocumentsSettingsBuilder | H2: ImportRdoSettingsBuilder | H2: DataSourceSettingsBuilder

- [Make your first REST call] (https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Make_your_first_REST_call.htm): Follow this 30-minute tutorial to connect to an API in a Relativity aiR instance by making your first REST call, using Postman and API authentication.
  - Second paragraph: Estimated completion time: 30 minutes
  - Headings: H1: Make your first REST call | H2: Before you begin | H2: API authentication | H2: Make your first REST call to Relativity | H2: Troubleshoot a REST call | H3: Not authenticated | H3: Incorrect HTTP Verb | H3: 404 Not Found

- [Object Manager Fundamentals] (https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Object_Manager_-_A_Primer.htm): This quick reference describes the Object Manager API available in .NET, which exposes a HTTP service through REST. This API exposes CRUDQ and mass operation operations for Relativity Dynamic Objects (RDOs). Except for the create operation, it also supports these endpoints for Document objects.
  - Second paragraph: See these related pages:
  - Headings: H1: Object Manager Fundamentals | H2: Sample use cases | H2: Required references | H2: Creating a connection to the service | H2: Object Manager service in .NET versus REST | H2: CRUDQ operations in Object Manager service | H2: Calls to QueryAsync() versus QuerySlimAsync() methods | H2: Sample .NET and REST calls | H3: .NET coding sample | H3: REST coding sample | H2: Considerations

- [Performance Best Practices] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Performance_Best_Practices.htm): Apply best practices for Import Service API performance, such as using UTF-16 encoded extracted text files to avoid encoding conversion in document and image imports.
  - Second paragraph: For improved performance when working with fileshare data on ADLS, we highly recommend using extracted text or other long text files encoded in UTF-16. By doing so, you can avoid the need for conversion to the correct encoding, leading to significant time savings in your document and image workflows.
  - Headings: H1: Performance Best Practices | H2: Import Job Settings | H3: FileSizeColumnIndex

- [Relativity artifact identifiers] (https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Relativity_artifact_identifiers.htm): You can identify Relativity artifacts of different types using Artifact ID and GUIDs.
  - Second paragraph: Relativity artifacts are identified by unique Artifact IDs, corresponding to the primary database table identifier. The following is an example of querying the Documents table workspace database with the Artifact ID.
  - Headings: H1: Relativity artifact identifiers | H2: Artifact ID | H2: Artifact type | H2: GUID

- [Samples types and structure] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Sample_types_and_structure.htm): Review the Export Service API sample applications, a .NET console app and PowerShell scripts, and learn how to run a sample that exports from folders, saved searches, or productions.
  - Second paragraph: List of samples:
  - Headings: H1: Samples types and structure | H2: KeplerClient Code Samples

- [Samples types and structure] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Sample_types_and_structure.htm): Learn the types and structure of the Import Service API sample applications: .NET 7 console, Kepler client console, and PowerShell REST samples.
  - Second paragraph: Samples follow the following structure:
  - Headings: H1: Samples types and structure | H2: .NET 7 Code Samples | H2: KeplerClient Code Samples | H2: Powershell Script Samples

- [SDK and Nuget Compatibility] (https://platform.relativity.com/RelativityaiR/Content/Getting_Started/SDK_and_Nuget_Compatibility.htm): Find where SDK and NuGet compatibility information moved. This topic points to Download the SDKs and NuGet packages.
  - Headings: H1: SDK and Nuget Compatibility

- [Set up your developer environment] (https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Set_up_a_developer_environment.htm): Set up your environment for developing with Relativity aiR by installing the Relativity Visual Studio templates and setting up Relativity Community and DevHelp accounts.
  - Second paragraph: Use these steps to install the Relativity templates through Visual Studio:
  - Headings: H1: Set up your developer environment | H2: Step 1 - Install the Relativity Visual Studio templates | H2: Step 2 - Set up Relativity Community and DevHelp accounts

- [Storing and using external API credentials] (https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Storing_and_using_external_API_credentials.htm): Learn how to connect to external APIs from a Relativity extensibility point and pass credentials, using a pre-save event handler and Google
  - Second paragraph: Estimated completion time: 30 minutes
  - Headings: H1: Storing and using external API credentials | H2: Before you begin | H2: Create the Relativity Dynamic Object (RDO) | H2: Build the extensibility point | H2: Store the credential | H3: Using Secret Store | H3: Using encrypted Instance Settings | H2: Fetch the API authentication information | H2: Call the API with authentication | H2: Test the validator


### Identity
- [Authentication provider type (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Authentication_Provider_Type__.NET_.htm): The Authentication Provider Type Manager API exposes functionality for programmatically enabling and disabling authentication protocols through .NET. It also provides methods to read one or more provider types.
  - Second paragraph: The Authentication Provider Type API exposes functionality for programmatically enabling and disabling authentication protocols used by Relativity. It also provides methods to read one or more provider types.
  - Headings: H1: Authentication provider type (.NET) | H2: Fundamentals for the Authentication Provider Type API | H3: Methods | H3: Classes | H2: Guidelines for the Authentication Provider Type API | H2: Code sample

- [Authentication provider type (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Authentication_Provider_Type__REST_.htm): The Authentication Provider Type Manager service exposes functionality for programmatically enabling and disabling authentication protocols through REST. It also provides endpoints to read one or more provider types.
  - Second paragraph: The Authentication Provider Type service exposes functionality for programmatically enabling and disabling authentication protocols used by Relativity. It also provides endpoints to read one or more provider types.
  - Headings: H1: Authentication provider type (REST) | H2: Guidelines for the Authentication Provider Type service | H3: URLS | H2: Retrieve an authentication provider type | H2: Read all authentication provider types | H2: Update an authentication provider type

- [Client Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Client_Manager_API.htm): The Client Manager API exposes CRUD operations on clients through .NET. It exposes helper methods for retrieving lists of available groups, matters, users, and statuses, and methods for creating, submitting, and retrying client domain activation keys.
  - Second paragraph: The Client Manager API exposes methods that provide the following functionality:
  - Headings: H1: Client Manager (.NET) | H2: Fundamentals for the Client Manager API | H3: Methods | H3: Classes | H2: Guidelines for the Client Manager API | H3: Create a client proxy | H3: Retrieve values from Task objects | H3: Use response data from read operations | H2: Create a client | H2: Retrieve a client | H2: Update a client | H2: Delete a client | H2: Helper methods for CRUD operations | H3: Retrieve associated groups | H3: Retrieve associated matters | H3: Retrieve associated users | H3: Retrieve available statuses | H2: Methods for client domain activation keys | H3: Create client domain activation key | H3: Submit a client domain activation key | H3: Retry activating a client domain

- [Client Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Client_Manager_service.htm): The Client Manager API exposes CRUD operations on clients through REST. It exposes helper endpoints for retrieving lists of available groups, matters, users, and statuses, and  endpoints for creating, submitting, and retrying client domain activation keys.
  - Second paragraph: The Client Manager service exposes endpoints that provide the following functionality:
  - Headings: H1: Client Manager (REST) | H2: Guidelines for the Client Manager service | H3: URLs | H2: Postman sample file | H2: Client code sample | H2: Create a client | H2: Retrieve a client | H2: Update a client | H2: Delete a client | H2: Helper endpoints for CRUD operations | H3: Retrieve associated groups | H3: Retrieve associated matters | H3: Retrieve associated users | H3: Retrieve available statuses | H2: Endpoints for client domain activation keys | H3: Create client domain activation key | H3: Submit a client domain activation key | H3: Retry activating a client domain

- [Federated Instance Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Federated_instance_manager__.NET_.htm): The  Federated Instance Manager API supports CRUD operations on federated instances through .NET. You can use this service after configuring a Relativity environment to use federated instances.
  - Second paragraph: The  Federated Instance Manager API supports CRUD operations on federated instances. You can use this API after configuring a Relativity environment to use federated instances. For example, you can retrieve a list of all federated instances defined for a Relativity environment.
  - Headings: H1: Federated Instance Manager (.NET) | H2: Fundamentals for the Federated Instance Manager API | H2: Guidelines for the  Federated Instance Manager API | H3: Calls to the UpdateAsync() method | H2: Code sample

- [Federated Instance Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Federated_instance_manager__REST_.htm): The  Federated Instance Manager service supports CRUD operations on federated instances through REST. You can use this service after configuring a Relativity environment to use federated instances.
  - Second paragraph: The  Federated Instance Manager service supports CRUD operations on federated instances. You can use this service after configuring a Relativity environment to use federated instances. For example, you can retrieve a list of all federated instances defined for a Relativity environment.
  - Headings: H1: Federated Instance Manager (REST) | H2: Guidelines for the Federated Instance Manager service | H3: URLs | H3: Required permissions | H2: Create a federated instance | H2: Retrieve a single federated instance | H2: Retrieve all federated instances | H2: Update a federated instance | H2: Delete a federated instance

- [Group Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Group_Manager_API.htm): The Group Manager API exposes CRUD and query operations on groups through .NET. It includes operations for adding and removing users and querying on available users and clients to associate with a group. This API also exposes mass operations for adding and removing multiple users to or from multiple groups.
  - Second paragraph: The Group Manager API exposes methods that provide the following functionality:
  - Headings: H1: Group Manager (.NET) | H2: Fundamentals for the Group Manager API | H3: Methods | H3: Classes | H2: Create a group | H2: Retrieve a group | H2: Update a group | H2: Delete a group | H2: Query for group members | H2: Add users to a group | H2: Remove users from a group | H2: Helper methods for users and clients | H3: Query for clients to associate with a group | H3: Query for users to add to a group | H3: Query for groups assigned to a user | H2: Mass operations on groups | H3: Add multiple users to multiple groups | H3: Remove multiple users from multiple groups

- [Group Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Group_Manager_service.htm): The Group Manager API exposes CRUD and query operations on groups through REST. It includes operations for adding and removing users and querying on available users and clients to associate with a group. This API also exposes mass operations for adding and removing multiple users to or from multiple groups.
  - Second paragraph: The Group Manager service exposes endpoints that provide the following functionality:
  - Headings: H1: Group Manager (REST) | H2: Guidelines for the Group Manager service | H3: URLs | H2: Client code sample | H2: Create a group | H2: Retrieve a group | H2: Update a group | H2: Delete a group | H2: Add users to a group | H2: Remove users from a group | H2: Helper methods for users and clients | H3: Query for clients to associate with a group | H3: Query for users to add to a group | H3: Query for group members | H3: Query groups assigned to a user | H2: Mass operations on groups | H3: Add multiple users to multiple groups | H3: Remove multiple users from multiple groups

- [Identity (authentication and user accounts)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Identity.htm): This page provides an overview of authentication provider types and login profiles available through Relativity APIs in .NET and REST, such as OAuth2 providers. It also includes information about setting user permissions, and adding users, clients, and groups to Relativity.
  - Second paragraph: Relativity uses several industry-standard technologies, enabling versatile authentication options. It supports local (such as password related) or external (such as smart cards, or external identification providers) authentication methods. You can add and enable each type individually, as well as assigning at least one, and in some instances multiple methods, for each user.
  - Headings: H1: Identity (authentication and user accounts) | H2: General concepts | H3: Authentication provider types and login profiles | H3: Client manager | H3: Federated instance manager | H3: Group manager | H3: Permissions manager | H3: User manager | H2: Current Identity API content | H2: Version History

- [Login Profile Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Login_profile_manager__.NET_.htm): The Login Profile Manager API exposes operations for retrieving the global authentication profile and user profiles and updating profiles through .NET. It also supports helper methods for sending invitations to users to log in to Relativity and set their passwords.
  - Second paragraph: The Login Profile Manager API is uses to configure authentication profiles and user login profiles:
  - Headings: H1: Login Profile Manager (.NET) | H2: Fundamentals for the Login Profile Manager API | H2: Guidelines for the Login Profile Manager API | H3: Read a user login profile and create a login method

- [Login Profile Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Login_profile_manager__REST_.htm): The Login Profile Manager service exposes operations for retrieving the global authentication profile and user profiles and updating profiles through REST. It also supports helper endpoints for sending invitations to users to log in to Relativity and set their passwords.
  - Second paragraph: The Login Profile Manager service is used to configure authentication profiles and user login profiles.
  - Headings: H1: Login Profile Manager (REST) | H2: Guidelines for the Login Profile Manager service | H3: URLs | H2: Get global authentication profile | H2: Update an authentication profile | H2: Get a login profile for a user | H2: Update a login profile for a user | H2: Helper endpoints for invitation emails | H3: Verify that invitation emails can be sent successfully | H3: Send a single invitation email | H3: Send bulk invitations to users | H3: Set a user's password | H3: Reset authenticator secret (2FA)

- [OAuth2 Client Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2_Client_Manager__.NET_.htm): The OAuth2Client Manager API exposes CRUD operations for OAuth2 clients through .NET. It also supports generating  secrets for OAuth2 clients.
  - Second paragraph: The OAuth2Client Manager API exposes CRUD operations for OAuth2 clients. It also supports generating  secrets for OAuth2 clients.
  - Headings: H1: OAuth2 Client Manager (.NET) | H2: Fundamentals for the OAuth2 Client Manager API | H2: Guidelines for the OAuth2 Client Manager API | H2: Create an OAuth2 client | H2: Update an OAuth2 client | H2: Regenerate a client secret

- [OAuth2 Client Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2_Client_Manager__REST_.htm): The OAuth2Client Manager API exposes CRUD operations for OAuth2 clients through REST. It also supports generating  secrets for OAuth2 clients.
  - Second paragraph: The OAuth2Client Manager API exposes CRUD operations for OAuth2 clients. It also supports generating  secrets for OAuth2 clients.
  - Headings: H1: OAuth2 Client Manager (REST) | H2: Guidelines for the OAuth2 Client Manager service | H3: URLs | H2: Create an OAuth2 client | H3: Create a client with flow and redirectUrs | H3: Create a client with OAuth2Client object | H2: Update an OAuth2 client | H2: Delete an OAuth2 client | H2: Regenerate a client secret

- [Permission Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permission_Manager_API.htm): The Permissions Manager API exposes operations for setting and getting item, user, and workspace permissions through .NET. It also supports setting, updating, and deleting custom permissions, and provides helper methods for querying on permissions.
  - Second paragraph: The Services API supports a set of operations for assigning system-defined permissions on the admin, workspace, and item level. You can manipulate either arbitrary sets of individual permissions, or entire admin, workspace, or item permission sets. Note that the logic for working with entire permission sets closely follows the logic of the Relativity permissions UI.
  - Headings: H1: Permission Manager (.NET) | H2: Permissions fundamentals | H2: Typical use cases | H3: Modify permissions for a group | H3: Apply item level security for specific objects | H3: Get Permissions for logged in user | H2: Work with individual permissions | H3: Permission objects | H3: Query permissions | H3: Read a permission | H3: Read the current user and group permission values | H3: Set permission values | H2: Custom permissions | H3: Create a permission | H3: Read a permission | H3: Update a permission | H3: Delete a permission | H2: Add and remove groups to permissions | H3: Admin groups | H3: Workspace groups | H3: Item groups | H2: Enable item-level security | H3: Get item-level security | H3: Set item-level security | H2: Set group permissions | H3: Admin group permissions | H3: Workspace group permissions | H3: Item group permissions | H2: User lookup in groups | H3: Get admin group users | H3: Get workspace group users | H3: Get item group users

- [Permission Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permission_Manager_service.htm): The Permissions Manager API exposes operations for setting and getting item, user, and workspace permissions through REST. It also supports setting, updating, and deleting custom permissions, and provides helper endpoints for querying on permissions.
  - Second paragraph: You can only use the POST method when interacting with the service.
  - Headings: H1: Permission Manager (REST) | H2: Client code sample | H2: Get admin groups | H2: Get workspace groups | H2: Get item groups | H2: Add and remove admin groups | H2: Add and remove workspace groups | H2: Add and remove item groups | H2: Get admin permissions | H2: Get workspace permissions | H2: Get item permissions | H2: Set admin permissions | H2: Set workspace permissions | H2: Get item-level security | H3: GetItemLevelSecurityAsync | H3: GetItemLevelSecurityListAsync | H2: Set item-level security | H2: Set item permissions | H2: Get admin group users | H2: Get workspace group users | H2: Get item group users | H2: Query permissions | H2: Read a single permission | H2: Get selected permissions for current user | H3: GetPermissionSelectedAsync | H3: GetPermissionSelectedListAsync | H2: Get selected permissions for a group | H2: Set selected permissions for a group | H2: Create a custom permission | H2: Update a custom permission | H2: Delete a custom permission

- [Permissions access control] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permissions_access_control_REST_API_Reference.htm): Browse the Permissions access control REST API reference for endpoint details on managing role assignments.
  - Headings: H1: Permissions access control REST API Reference | H2: Permissions access control

- [Permissions access control API] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permissions_access_control_API__REST_.htm): Use the permissions access control REST API to list, assign, and revoke role assignments at the fileshare and instance levels in Staging, and review the URL format and guidelines.
  - Second paragraph: The transition to this new permissions approach will occur gradually, allowing for a smooth and organized migration from the current system.
  - Headings: H1: Permissions access control API | H2: Guidelines for the permissions access control API | H3: URL address format | H3: Considerations | H2: Authentication requirements | H3: Token requirements | H2: Identifier guide | H3: Node Key | H3: Group ID (groupId) | H3: Role Key (roleKey) | H3: List current role assignments on a fileshare | H3: Batch assign and revoke roles on a fileshare | H3: List current role assignments on the tenant | H3: Batch assign and revoke roles on the tenant

- [Permissions access control REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/PermissionsaccesscontrolRESTAPI.html): Permissions access control REST API Reference

- [Relativity Identity .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Identity_NET_API_Reference.htm): Browse the .NET API reference for Relativity Identity, provided in the Relativity.Identity.SDK.
  - Headings: H1: Relativity Identity .NET API Reference | H2: Relativity.Identity.SDK

- [Relativity Identity .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/IdentityNETAPI.html): Relativity Identity .NET API Reference

- [Relativity Identity REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Identity_REST_API_Reference.htm): Browse the Relativity Identity REST API reference for the Relativity-Identity service, including its endpoints and the OAS file.
  - Headings: H1: Relativity Identity REST API Reference | H2: Relativity-Identity

- [Relativity Identity REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/IdentityRESTAPI.html): Relativity Identity REST API Reference

- [Relativity OAuth2 Client .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2ClientNETAPI.html): Relativity OAuth2 Client .NET API Reference

- [Relativity OAuth2 Client .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2_Client_NET_API_Reference.htm): Browse the Relativity OAuth2 Client .NET API reference for the Relativity.OAuth2.Client SDK, including its types and members.
  - Headings: H1: Relativity OAuth2 Client .NET API Reference | H2: Relativity.OAuth2.Client

- [User Manager] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/User_Manager_service.htm): The User Manager API supports CRUD operations on users through REST. It also provides helper endpoints for retrieving user types and groups to associate with users, and for retrieving and querying on lists of users.
  - Second paragraph: The User Manager API exposes endpoints that provide the following functionality:
  - Headings: H1: User Manager (REST) | H2: Guidelines for the User Manager service | H3: URLs | H2: Client code sample | H2: Create a user | H2: Retrieve metadata for a user | H2: Retrieve settings for the current user | H2: Update properties for a user | H2: Update settings for the current user | H2: Delete a user | H2: Helper endpoints for querying on users | H3: Retrieve available types for users | H3: Query for groups to associate with users | H3: Retrieve information about the current user | H3: Retrieve all users in a workspace | H3: Retrieve active users in a workspace | H3: Retrieve users in workspace with Relativity access | H3: Query for users in a workspace

- [User Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Identity/User_Manager_API.htm): The User Manager API supports CRUD operations on users through .NET. It also provides helper methods for retrieving user types and groups to associate with users, and for retrieving and querying on lists of users.
  - Second paragraph: The User Manager API exposes methods that provide the following functionality:
  - Headings: H1: User Manager (.NET) | H2: Fundamentals for the User Manager API | H2: Guidelines for the User Manager API | H2: Create a user | H2: Retrieve metadata for a user | H2: Retrieve settings for the current user | H2: Update properties for a user | H2: Update settings for the current user | H2: Delete a user | H2: Helper methods for querying on users | H3: Retrieve all available types for users | H3: Retrieve all users for a workspace | H3: Query for users in a workspace


### Imaging
- [Imaging (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_API.htm): Use the Imaging .NET API to run and cancel imaging jobs and manage imaging profiles, sets, and application field codes programmatically.
  - Second paragraph: Sample use cases for the imaging services include:
  - Headings: H1: Imaging (.NET) | H2: Imaging API fundamentals | H2: SDK for Imaging API | H2: Imaging Profile Manager | H2: Imaging Set Manager | H2: Native Type Manager | H2: Application Field Code Manager | H2: Imaging Job Manager | H2: Document Status Manager | H2: Imaging Environment Manager

- [Imaging (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_API_services_for_REST.htm): Use the Imaging REST services to automate imaging jobs, profiles, sets, and native types, and review the guidelines for calling them over HTTP.
  - Second paragraph: Sample use cases for the imaging services include:
  - Headings: H1: Imaging API (REST) | H2: Guidelines for the Imaging services | H3: URLs | H2: Imaging Profile Manager | H2: Imaging Set Manager | H2: Native Type Manager | H2: Application Field Code Manager | H2: Imaging Job Manager | H2: Document Status Manager | H2: Imaging Environment Manager

- [Imaging .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/ImagingNETAPI.html): Imaging .NET API Reference

- [Imaging .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_NET_API_Reference.htm): Browse the Imaging .NET API reference for the Relativity.Imaging.SDK, including its interfaces and classes.
  - Headings: H1: Imaging .NET API Reference | H2: Relativity.Imaging.SDK

- [Imaging Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging.htm): Find the Imaging business domain landing page, with links to the .NET and REST imaging content, previous versions, and the version history of the Imaging SDK.
  - Headings: H1: Imaging | H2: Current Imaging API content | H2: Version History

- [Imaging REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/ImagingRESTAPI.html): Imaging REST API Reference

- [Imaging REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_REST_API_Reference.htm): Browse the Imaging REST API reference for the relativity-imaging service and its endpoints.
  - Headings: H1: Imaging REST API Reference | H2: relativity-imaging


### Infrastructure
- [Infrastructure .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/InfrastructureNETAPI.html): Infrastructure .NET API Reference

- [Infrastructure .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Infrastructure_NET_API_Reference.htm): Browse the Infrastructure .NET API reference for the Relativity.Infrastructure.SDK, including its interfaces and classes.
  - Headings: H1: Infrastructure .NET API Reference | H2: Relativity.Infrastructure.SDK

- [Infrastructure Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Infrastructure.htm): Find the Infrastructure business domain landing page, with links to the Infrastructure SDK, Notifications Manager (MotD), and Resource Server and Resource Pool API content.
  - Second paragraph: The Notifications Manager API exposes methods for reading, updating, and dismissing the MotD. It also includes methods for determining whether the MotD has been dismissed, and whether it is displayed as plain text or HTML.
  - Headings: H1: Infrastructure | H2: Current Infrastructure API documentation | H2: Version History

- [Notifications Manager (MotD) - (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Notifications_Manager_API__MotD_.htm): The Message of the Day (MotD) is a message displayed to all users when they log into Relativity. MotD is most commonly used to inform users of planned system maintenance. The Services API supports asynchronous read and update operations on the MotD.
  - Second paragraph: The Notifications Manager API exposes methods for reading, updating, and dismissing the MotD. It also includes methods for determining whether the MotD has been dismissed, and whether it is displayed as plain text or HTML.
  - Headings: H1: Notifications Manager (MotD) - (.NET) | H2: Fundamentals for the Notifications Manager API | H3: Methods | H3: Classes | H2: Read the MotD | H2: Update the MotD | H2: Dismiss the MotD | H2: Has Dismissed the MotD | H2: Display the MotD

- [Notifications Manager (MotD) - (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Notifications_Manager_service__MotD_.htm): Use the Notifications Manager REST service to read, update, and dismiss the Message of the Day (MotD) and check whether it is dismissed or displayed as HTML.
  - Second paragraph: The Notifications Manager API exposes methods for reading, updating, and dismissing the MotD. It also includes methods for determining whether the MotD has been dismissed, and whether it is displayed as plain text or HTML.
  - Headings: H1: Notifications Manager (MotD) - (REST) | H2: Guidelines for the Notifications Manager service | H3: URLs | H2: Postman sample file | H2: Client code sample | H2: Read a MotD | H2: Update a MotD | H2: Dismiss a MotD | H2: Check for the dismissal of a MotD | H2: Check for text or HTML format of a MotD

- [Notifications REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/NotificationsRESTAPI.html): Notifications REST API Reference

- [Notifications REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Notifications_REST_API_Reference.htm): Browse the Notifications REST API reference for the relativity-notifications service and its endpoints.
  - Headings: H1: Notifications REST API Reference | H2: relativity-notifications

- [Resource Server / Resource Pool (.NET / REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Resource_Server_Resource_Pool_API.htm): Use the Resource Server and Resource Pool APIs through .NET or REST to check server status, manage agents, restart services, and manage server credentials.
  - Second paragraph: Use cases for these APIs include:
  - Headings: H1: Resource Server / Resource Pool (.NET / REST) | H2: Resource Server / Resource Pool fundamentals | H3: Overview | H3: REST guidelines | H3: Server types

- [Resource Server Resource Pool REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Resource_Server_Resource_Pool_REST_API.htm): Browse the Resource Server and Resource Pool REST API reference, including endpoint documentation and the OAS file.
  - Headings: H1: Resource Server Resource Pool REST Reference

- [Resource Server Resource Pool REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/ResourceServerResourcePoolRESTAPI.html): Resource Server Resource Pool REST Reference


### Integrate
- [Integrate with the Relativity Platform] (https://platform.relativity.com/RelativityaiR/Content/Integrate/Integrate.htm): Start here to write and host your own code that uses Relativity APIs, with links to API introductions, tutorials, how-tos, best practices, tools, and the Relativity aiR MCP.
  - Headings: H1: Integrate with the Relativity Platform

- [Integration APIs and Services] (https://platform.relativity.com/RelativityaiR/Content/Integrate/APIS-Services.htm): Landing page listing the integration APIs and services available for integrating with Relativity.
  - Second paragraph: (REST-only API)
  - Headings: H1: Integration APIs and Services

- [Integration fundamentals and concepts] (https://platform.relativity.com/RelativityaiR/Content/Integrate/Fundamentals-and-concepts.htm): Learn the fundamentals and basic concepts of integrating with Relativity, starting with an overview of the Relativity REST API and its REST services.
  - Headings: H1: Integration fundamentals and concepts

- [Integration Tools and Resources] (https://platform.relativity.com/RelativityaiR/Content/Integrate/Tools-Resources.htm): Find tools and resources for integrating with Relativity, including the integration APIs list, the Relativity NuGet Gallery, the Relativity aiR MCP, and external tools.
  - Headings: H1: Integration Tools and Resources | H2: Relativity Tools and Resources | H2: External Tools and Resources

- [Integration tutorials] (https://platform.relativity.com/RelativityaiR/Content/Integrate/Tutorials.htm): Landing page for tutorials on building your own self-hosted applications that integrate with Relativity aiR.
  - Headings: H1: Tutorials for integrating with Relativity aiR

- [Introduction to Relativity APIs] (https://platform.relativity.com/RelativityaiR/Content/Integrate/Introduction.htm): Learn the conventions and standards behind Relativity APIs, what the API documentation offers, and how Relativity extensibility has moved from a PaaS model toward SaaS.
  - Second paragraph: This site provides guidance to help you ramp up, discover and utilize Relativity’s APIs. Broadly speaking, the guidance includes:
  - Headings: H1: Introduction to Relativity APIs | H2: Conventions & Standards | H2: API documentation | H2: Extending Relativity vs. Integrating with Relativity | H2: Extensibility maturity journey | H3: A PaaS beginning | H3: Adopting SaaS | H3: Direct data access focused APIs | H3: SaaS evolution | H3: Known challenges


### Kepler framework
- [Cancellation and progress] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Cancellation_and_progress.htm): Learn how to cancel long-running Kepler service calls with a CancellationToken and how to return progress information while calls execute.
  - Second paragraph: The Kepler framework supports the cancellation of requests have long running times. To use this functionality, pass a CancellationToken object as an argument to your service method. See the following sample code:
  - Headings: H1: Cancellation and progress | H2: Cancellation | H2: Progress | H2: Long running process (LRP) vs Remote procedure call (RPC) | H2: Disposition of the proxy for progress and cancellation

- [Dependency Injection] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Dependency_injection.htm): Learn how the Kepler framework uses Castle Windsor for dependency injection, and how to register dependencies with a Windsor installer so controllers receive them.
  - Second paragraph: In certain use cases, you may want to run the Windsor installer on an assembly that doesn't contain a Kepler service. You must add the following attribute to your assembly for the Kepler framework to detect it:
  - Headings: H1: Dependency Injection | H2: Dependency injection in the Kepler | H2: Assemblies without a Kepler service | H2: Dependency injection through ADS

- [Deploy Kepler services through ADS] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Deploy_Kepler_services_through_ADS.htm): Deploy or update your Kepler service assemblies in Relativity through the Application Deployment System (ADS), and export services as part of an ADS application.
  - Second paragraph: Use the following steps to deploy your service assemblies (.dll files) to Relativity through the ADS framework.
  - Headings: H1: Deploy Kepler services through ADS | H2: Deploy a Kepler service | H2: Export a RAP with Kepler services | H2: Upgrade an application

- [HTTP headers, verbs, and related information] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/HTTP_headers__verbs__and_related_information.htm): Customize a Kepler service by setting the required X-CSRF-Header, specifying HTTP verbs with attributes, overriding status codes, and modifying REST responses.
  - Second paragraph: The Kepler framework requires X-CSRF-Header to prevent CSRF attacks.
  - Headings: H1: HTTP headers, verbs, and related information | H2: X-CSRF-Header | H2: HTTP verbs | H2: Status Codes | H2: ResponseController class | H2: Localization | H2: Query Parameters

- [Kepler Client SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/KeplerClientNETAPI.html): Kepler Client SDK .NET API Reference

- [Kepler Client SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_Client_NET_API_Reference.htm): Reference for the Relativity.Kepler.Client.SDK .NET API used to call Kepler services from client code.
  - Headings: H1: Kepler Client SDK .NET API Reference | H2: Relativity.Kepler.Client.SDK

- [Kepler framework] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_framework.htm): Learn how the Kepler framework lets you build custom REST endpoints through a .NET interface, its advantages, and the server-side and client-side implementation workflow.
  - Second paragraph: Kepler services offer these advantages:
  - Headings: H1: Kepler framework | H2: Basic concepts and implementation workflow for a Kepler service | H3: Server-side implementation of Kepler service | H3: Client-side interactions with a Kepler service | H2: NuGet package for the Kepler framework | H2: Kepler FAQs | H2: Version History | H3: Relativity.Kepler.Client.SDK | H3: Relativity.Kepler.SDK

- [Kepler SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/KeplerNETAPI.html): Kepler SDK .NET API Reference

- [Kepler SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_NET_API_Reference.htm): Reference for the Relativity.Kepler .NET SDK API used to build Kepler services.
  - Headings: H1: Kepler SDK .NET API Reference | H2: Relativity.Kepler

- [Kepler service structure and components] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_service_structure_and_components.htm): Learn how the Kepler framework uses modules, routing, exceptions, and versioning to detect and organize services, and how to deprecate outdated services.
  - Second paragraph: A service module automatically includes all of the services that are defined in the same root namespace or deeper. It works by using convention over configuration, which means that services aren't directly assigned to a module. When the Kepler framework is initialized, it scans all of the classes in your DLL to detect the modules and services that you have defined in your code.
  - Headings: H1: Kepler service structure and components | H2: Modules | H2: Routing | H2: ServiceAudience attribute | H2: Interfaces | H2: Exceptions | H2: Versioning for Kepler APIs | H3: Example of a versioned service | H2: Obsolete attribute | H3: Deprecate a service | H3: Deprecate an endpoint

- [Proxies and authentication] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Proxies_and_authentication.htm): Use the ServiceFactory class to create Kepler client proxies with bearer token or other credentials, and learn the available authentication methods.
  - Second paragraph: Use the following parameters to construct a ServiceFactory object, which is available through the ServiceFactorySettings class:
  - Headings: H1: Proxies and authentication | H2: ServiceFactory class | H3: Create a proxy using Bearer Token | H3: Create a proxy using username and password | H2: Client .NET proxy | H2: Authentication for Kepler services | H3: Oauth2 credentials | H3: Cookie authentication

- [Serialization and streaming] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Serialization_and_streaming.htm): Learn how the Kepler framework serializes data as JSON by default, and how to implement custom serializers with IModelSerializer and custom streaming.
  - Second paragraph: The Kepler framework supports serializing objects as JSON representations using the JsonMediaTypeFormatter class available through .NET. This class uses the Json.NET library to perform serialization, so it handles only JSON formatted data. The default serializer provided by the Kepler framework is designed to meet the needs of most use cases. For more information, see JSON Media-Type Formatter on the Microsoft website and Json.NET in the Json.NET Documentation site.
  - Headings: H1: Serialization and streaming | H2: Serialization | H3: Custom serializers | H3: Custom deserializer | H2: Streaming | H3: Constructors for KeplerStream class | H3: Properties on KeplerStream class | H3: Method on KeplerStream class | H3: Special considerations for streaming

- [Template for Kepler services] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Template_for_Kepler_services.htm): Use the Relativity Kepler Project Template in Visual Studio to jump start a Kepler service, including prerequisites and creating a new service solution.
  - Second paragraph: Complete the following tasks to before you begin implementing a custom Kepler service:
  - Headings: H1: Template for Kepler services | H2: Before you begin | H2: Install the Relativity Kepler Project Template | H2: Create a new Kepler service solution | H2: Send requests to a service | H2: Uninstall the Relativity Kepler Project Template

- [Troubleshooting Kepler services] (https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Troubleshooting_Kepler_services.htm): Troubleshoot custom Kepler services, including missing service module errors, GET endpoints that fail, and invalid RoutePrefix or WebService attributes that cause 404 or 500 errors.
  - Second paragraph: You must bundle a given set of Kepler services in a module before you add them to an ADS application in Relativity. If the services aren't added to a module, you receive the following error listing the services:
  - Headings: H1: Troubleshooting Kepler services | H2: Assembly doesn't contain service module | H2: Deleted applications | H2: GET endpoint fails | H2: Invalid RoutePrefix attribute causes 404 error | H2: Invalid WebService attribute causes 500 error | H2: Missing or no endpoints on a service | H2: Multiple modules error | H2: Multiple service implementations error | H2: Namespace doesn't exist error message | H2: ServiceAudience error


### Keyword Search
- [Keyword Search Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Keyword_Search/Keyword_Search.htm): Find the Keyword Search business domain landing page, with its changelog, SDK compatibility information, and links to the Keyword Search Manager .NET and REST content.
  - Second paragraph:  
  - Headings: H1: Keyword Search | H2: Keyword Search changelog | H2: Current Keyword Search API content

- [Keyword Search Manager (.NET) for saved searches] (https://platform.relativity.com/RelativityaiR/Content/BD_Keyword_Search/Keyword_Search_Manager_API.htm): Keyword search (or SQL index search) is Relativity
  - Second paragraph: The Keyword Search Manager API supports the create, read, update, delete, and query operations on a KeywordSearch DTO. It also includes helper methods to facilitate returning saved search parameters available to the user in the workspace, such as fields, search owners, search indexes are also provided. You can also generate email links to the search results. The operations on KeywordSearch DTOs  are performed asynchronously. Note that asynchronous operations return a standard .NET System.Threading.Tasks.Task<TResult> object that can be used to monitor progress and interact with the process.
  - Headings: H1: Keyword Search Manager (.NET) for saved searches | H2: KeywordSearch properties | H2: Create a KeywordSearch | H2: Read KeywordSearch | H2: Update KeywordSearch | H2: Delete KeywordSearch | H2: Query KeywordSearches | H2: Helper methods | H2: Email a link to KeywordSearch | H2: Move KeywordSearch | H2: Copy KeywordSearch | H2: Exception handling | H3: ServiceException | H3: ValidationException

- [Keyword Search Manager (REST) for saved searches] (https://platform.relativity.com/RelativityaiR/Content/BD_Keyword_Search/Keyword_Search_Manager_service.htm): This topic describes how to interact with the Relativity saved keyword search using the REST API.
  - Second paragraph: The Keyword Search Manager API supports the create, read, update, delete, and query operations on a KeywordSearch DTO. It also includes helper methods to facilitate returning saved search parameters available to the user in the workspace, such as fields, search owners, search indexes are also provided. You can also generate email links to the search results.
  - Headings: H1: Keyword Search Manager (REST) for saved searches | H2: Client code sample | H2: Create | H3: Search condition criteria | H2: Read | H2: Update | H2: Delete | H2: Query | H2: Move | H2: Copy | H2: Helper operations | H3: GetEmailToLinkUrlAsync | H3: GetFieldsForCriteriaConditionAsync | H3: GetFieldsForObjectCriteriaCollectionAsync | H3: GetFieldsForSearchResultViewAsync | H3: GetSearchIncludesAsync | H3: GetSearchOwnersAsync | H3: GetAccessStatusAsync


### Legal Hold API
- [Legal Hold API] (https://platform.relativity.com/RelativityaiR/Content/Legal_Hold_API/Legal_Hold_API.htm): Learn about the Legal Hold APIs, including Graph API authorization and the ActiveCustodianSummary endpoint that returns actively on-hold custodians for matter or project management.
  - Second paragraph: The following APIs can be used for any matter or project management function, including integrating with matter management systems.
  - Headings: H1: Legal Hold APIs | H2: Matter or project management | H3: ActiveCustodianSummary | H3: Creating a Legal Hold project | H3: Querying a Legal Hold project | H3: Querying for Custodians on a Legal Hold project | H3: Creating a communication | H2: Preservation in Place (PIP Application) | H3: Preserving data | H3: Releasing data | H3: Closing preservation | H2: HR Integrations | H3: Creating an entity | H3: Updating entity employee status | H2: Task Management | H3: Creating a Legal Hold task | H3: Updating Legal Hold task status

- [Legal Hold REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/Legal_Hold_API/LegalHoldRESTAPI.html): Legal Hold API REST Reference

- [Legal Hold REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/Legal_Hold_API/Legal_Hold_REST_API_Reference.htm): REST API reference for the Legal Hold services (kCura.LegalHold.Services).
  - Headings: H1: Legal Hold REST API Reference | H2: kCura.LegalHold.Services


### Lists Interaction API
- [Class: FilterNode] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Class_FilterNode.htm): Filter.FilterNode
  - Second paragraph: Tree structure that contains Filter information
  - Headings: H1: Class: FilterNode | H3: Constructors | H3: Properties | H3: Methods | H2: Constructors | H3: constructor | H2: Properties | H3: info | H3: left | H3: right | H2: Methods | H3: toString

- [Class: FilterState] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Class_FilterState.htm): Filter.FilterState
  - Second paragraph: An object that contains filter information for the entire List Page
  - Headings: H1: Class: FilterState | H3: Constructors | H3: Properties | H2: Constructors | H3: constructor | H2: Properties | H3: filtersBrowserMap | H3: sampling | H3: savedSearch

- [Class: SampleState] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Class_SampleState.htm): SampleStateNotificationApi.SampleState
  - Second paragraph: Object to store the state of Sample Parameters (outgoing) and Details (incoming).
  - Headings: H1: Class: SampleState | H3: Constructors | H3: Properties | H2: Constructors | H3: constructor | H2: Properties | H3: sampleDetailsMap | H3: sampleParametersMap

- [Enumeration: BrowserID] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_BrowserID.htm): Browser.BrowserID
  - Second paragraph: Possible browser types
  - Headings: H1: Enumeration: BrowserID | H3: Enumeration Members | H2: Enumeration Members | H3: default | H3: fieldTree | H3: folder | H3: folderScope | H3: savedSearch | H3: savedSearchCondition | H3: savedSearchFolder

- [Enumeration: DataSourceID] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_DataSourceID.htm): DataSourceApi.DataSourceID
  - Second paragraph: Possible browser types
  - Headings: H1: Enumeration: DataSourceID | H3: Enumeration Members | H2: Enumeration Members | H3: itemList

- [Enumeration: FILTER_NODE_TYPE] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_NODE_TYPE.htm): Filter.FILTER_NODE_TYPE
  - Second paragraph: Used in a Filter Node Tree to determine a FilterNode's type
  - Headings: H1: Enumeration: FILTER_NODE_TYPE | H3: Enumeration Members | H2: Enumeration Members | H3: OPERAND | H3: OPERATOR

- [Enumeration: FILTER_OPERATOR] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_OPERATOR.htm): Filter.FILTER_OPERATOR
  - Second paragraph: Determines the condition being used for filtering in a FilterNode
  - Headings: H1: Enumeration: FILTER_OPERATOR | H3: Enumeration Members | H2: Enumeration Members | H3: AND | H3: NONE | H3: OR | H3: PARENTHESES

- [Enumeration: FILTER_TREE_NAMES] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_TREE_NAMES.htm): CustomConditionApi.FILTER_TREE_NAMES
  - Second paragraph: Possible Filter Tree names
  - Headings: H1: Enumeration: FILTER_TREE_NAMES | H3: Enumeration Members | H2: Enumeration Members | H3: global | H3: hidden | H3: user | H3: userGlobal | H3: widgetNative

- [Enumeration: FILTER_TYPES] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_TYPES.htm): FilterStateModificationApi.FILTER_TYPES
  - Second paragraph: Possible Filter types
  - Headings: H1: Enumeration: FILTER_TYPES | H3: Enumeration Members | H2: Enumeration Members | H3: CLUSTER | H3: DEFAULT | H3: FIELD_TREE | H3: FOLDER | H3: PRESERVED_FILTERS | H3: SAVED_SEARCH

- [Enumeration: FILTER_UPDATE_ACTIONS] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_UPDATE_ACTIONS.htm): FilterStateModificationApi.FILTER_UPDATE_ACTIONS
  - Second paragraph: Possible Filter update actions
  - Headings: H1: Enumeration: FILTER_UPDATE_ACTIONS | H3: Enumeration Members | H2: Enumeration Members | H3: ADD | H3: MODIFY | H3: REMOVE | H3: REPLACE

- [Enumeration: LongTextBehavior] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_LongTextBehavior.htm): ObjectManagerApi.LongTextBehavior
  - Second paragraph: Controls the behavior that is used when a Long Text field exceeds the configured character limit.
  - Headings: H1: Enumeration: LongTextBehavior | H3: Enumeration Members | H2: Enumeration Members | H3: Default | H3: DefaultWithErrors | H3: Tokenized | H3: TokenizedWithErrors

- [Enumeration: ToolbarContentSlotName] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_ToolbarContentSlotName.htm): ToolbarApi.ToolbarContentSlotName
  - Second paragraph: The location of the toolbar content
  - Headings: H1: Enumeration: ToolbarContentSlotName | H3: Enumeration Members | H2: Enumeration Members | H3: center | H3: left | H3: right

- [Enumeration: TreeNodeType] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_TreeNodeType.htm): Browser.TreeNodeType
  - Second paragraph: Possible TreeNode types
  - Headings: H1: Enumeration: TreeNodeType | H3: Enumeration Members | H2: Enumeration Members | H3: fieldTree_field | H3: fieldTree_folder | H3: fieldTree_root | H3: folderTree_folder | H3: folderTree_root | H3: searchTree_folder | H3: searchTree_root | H3: searchTree_search

- [Interface: ActiveObjectTypeProperties] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ActiveObjectTypeProperties.htm): ConvenienceApi.ActiveObjectTypeProperties
  - Second paragraph: Additional properties that are defined for the object type
  - Headings: H1: Interface: ActiveObjectTypeProperties | H3: Properties | H2: Properties | H3: guid | H3: pivotEnabled | H3: samplingEnabled | H3: supportsViews

- [Interface: ActiveObjectTypePropertiesApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ActiveObjectTypePropertiesApi.htm): ConvenienceApi.ActiveObjectTypePropertiesApi
  - Second paragraph: Contains an API to retrieve additional info about the object that the list is being displayed for
  - Headings: H1: Interface: ActiveObjectTypePropertiesApi | H3: Properties | H2: Properties | H3: getProperties

- [Interface: ActiveSearchInfo] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ActiveSearchInfo.htm): PageInfoApi.ActiveSearchInfo
  - Second paragraph: The active Saved Search or AdHoc Search Information
  - Headings: H1: Interface: ActiveSearchInfo | H3: Properties | H2: Properties | H3: activeRelationalFieldID | H3: isAdHoc | H3: savedSearchId | H3: savedSearchSearchProviderId | H3: savedSearchSorts | H3: viewFieldIds

- [Interface: BrowserPanelState] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_BrowserPanelState.htm): Browser.BrowserPanelState
  - Second paragraph: State information for the browser panel
  - Headings: H1: Interface: BrowserPanelState | H2: Hierarchy | H3: Properties | H2: Properties | H3: default | H3: fieldTree | H3: folder | H3: folderScope | H3: savedSearch | H3: savedSearchCondition | H3: savedSearchFolder | H3: selectedBrowser

- [Interface: BrowserState] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_BrowserState.htm): Browser.BrowserState
  - Headings: H1: Interface: BrowserState | H3: Properties | H2: Properties | H3: expandedNodes | H3: includeSubfolders | H3: selectedNode | H3: selectedNodeAncestorIDs | H3: selectedNodeParent | H3: selectedNodeSearchType | H3: selectedNodeType

- [Interface: ConfigApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConfigApi.htm): ConfigApi.ConfigApi
  - Second paragraph: Contains APIs to set and retrieve the application configuration
  - Headings: H1: Interface: ConfigApi | H3: Properties | H2: Properties | H3: getConfig | H3: onConfigLoaded | H3: setConfig

- [Interface: ConfigSettings] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConfigSettings.htm): ConfigApi.ConfigSettings
  - Second paragraph: Configuration object to send between to interaction scripts
  - Headings: H1: Interface: ConfigSettings | H2: Indexable | H3: Properties | H3: Methods | H2: Properties | H3: customMassOps | H3: hideCommandColumn | H3: hideExportDashboard | H3: massOpsToHide | H3: useHydroPreviewPane | H2: Methods | H3: resetPropertyValues

- [Interface: ConfirmModalModel] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConfirmModalModel.htm): ModalApi.ConfirmModalModel
  - Second paragraph: Modal used to display a confirmation message to the user
  - Headings: H1: Interface: ConfirmModalModel | H3: Properties | H2: Properties | H3: acceptAction | H3: acceptIsDestructive | H3: acceptText | H3: cancelAction | H3: cancelText | H3: closeOnAcceptActionFailure | H3: disableAcceptButtonAfterClick | H3: focusEls | H3: message | H3: title

- [Interface: ConvenienceApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConvenienceApi.htm): ConvenienceApi.ConvenienceApi
  - Second paragraph: Provides basic properties of the current list page and any tools that need to be shared with the script
  - Headings: H1: Interface: ConvenienceApi | H3: Properties | H2: Properties | H3: activeObjectTypeProperties | H3: artifactID | H3: artifactTypeID | H3: dashboardData | H3: dashboardID | H3: dashboardName | H3: massProcesses | H3: relativityHttpClient | H3: servicePathOverrides | H3: toggles | H3: useLiquidForms | H3: userTimezone | H3: utilities | H3: viewID | H3: workspaceID

- [Interface: CustomConditionApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_CustomConditionApi.htm): CustomConditionApi.CustomConditionApi
  - Second paragraph: Contains an API to allow registration of a custom condition that may not pertain to an existing field
  - Headings: H1: Interface: CustomConditionApi | H3: Properties | H2: Properties | H3: registerCustomCondition

- [Interface: CustomConditionCallbackResponse] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_CustomConditionCallbackResponse.htm): CustomConditionApi.CustomConditionCallbackResponse
  - Second paragraph: Defines the return type for a custom condition callback.
  - Headings: H1: Interface: CustomConditionCallbackResponse | H2: Hierarchy | H3: Properties | H2: Properties | H3: condition | H3: wasCancelled

- [Interface: CustomModalModel] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_CustomModalModel.htm): ModalApi.CustomModalModel
  - Second paragraph: Modal used to display an HTML element as content
  - Headings: H1: Interface: CustomModalModel | H3: Properties | H2: Properties | H3: actions | H3: contentElement | H3: noActions | H3: noHeader | H3: size | H3: title

- [Interface: DashboardApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_DashboardApi.htm): DashboardApi.DashboardApi
  - Second paragraph: Contains an API to get Dashboard information
  - Headings: H1: Interface: DashboardApi | H3: Properties | H2: Properties | H3: shouldShowDashboardsDropdown

- [Interface: DataSourceApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_DataSourceApi.htm): DataSourceApi.DataSourceApi
  - Second paragraph: Contains APIs to allow the registration of a different data source for the current list
  - Headings: H1: Interface: DataSourceApi | H3: Properties | H2: Properties | H3: dataSourceExists | H3: getFieldCollection | H3: registerColumnFormatter | H3: registerDataSource | H3: registerOverrideOperators | H3: retrieveDataSource

- [Interface: EventHandlerStatus] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_EventHandlerStatus.htm): ObjectManagerApi.EventHandlerStatus
  - Headings: H1: Interface: EventHandlerStatus | H3: Properties | H2: Properties | H3: FailingEventHandler | H3: Message | H3: Success

- [Interface: ExternalModalModel] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ExternalModalModel.htm): ModalApi.ExternalModalModel
  - Second paragraph: Modal used to display content from any URL in an iFrame
  - Headings: H1: Interface: ExternalModalModel | H3: Properties | H2: Properties | H3: closeAction | H3: cssClass | H3: focusEls | H3: height | H3: url | H3: width

- [Interface: Field] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_Field.htm): DataSourceApi.Field
  - Second paragraph: Used to identify a field
  - Headings: H1: Interface: Field | H3: Properties | H2: Properties | H3: ArtifactID | H3: FieldCategory | H3: FieldType | H3: Guids | H3: Name | H3: ViewFieldID

- [Interface: FieldRef] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FieldRef.htm): FieldRef.FieldRef
  - Second paragraph: Artifact ID of the Field
  - Headings: H1: Interface: FieldRef | H2: Hierarchy | H3: Properties | H2: Properties | H3: ArtifactID | H3: Guid | H3: Guids | H3: Name | H3: ViewFieldID | H3: artifactID | H3: name

- [Interface: FieldTypeRegistryApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FieldTypeRegistryApi.htm): FieldTypeRegistryApi.FieldTypeRegistryApi
  - Second paragraph: Contains APIs to allow developers to register their own custom field types and query field data
  - Headings: H1: Interface: FieldTypeRegistryApi | H3: Properties | H2: Properties | H3: getField | H3: getFieldNamePerArtifactId | H3: getFieldTypeIdForField | H3: registerFieldWithFieldType | H3: registerSupplementalFieldData

- [Interface: FieldTypeRegistryEntry] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FieldTypeRegistryEntry.htm): FieldTypeRegistryApi.FieldTypeRegistryEntry
  - Second paragraph: Object to store a Field to its Type IDs, Artifact IDs, and Categories
  - Headings: H1: Interface: FieldTypeRegistryEntry | H3: Properties | H2: Properties | H3: artifactId | H3: category | H3: fieldTypeId | H3: supplementalData

- [Interface: Filter] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_Filter.htm): Filter.Filter
  - Second paragraph: Interface for applying filters over the List Page
  - Headings: H1: Interface: Filter | H2: Hierarchy | H3: Properties | H2: Properties | H3: global | H3: hidden | H3: searchProviderBooleanOperator | H3: user | H3: userGlobal | H3: viewId | H3: widgetNative

- [Interface: FilterBase] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterBase.htm): Filter.FilterBase
  - Second paragraph: Set of filters
  - Headings: H1: Interface: FilterBase | H2: Hierarchy | H3: Properties | H2: Properties | H3: hidden | H3: user | H3: userGlobal | H3: widgetNative

- [Interface: FilterCondition] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterCondition.htm): Filter.FilterCondition
  - Second paragraph: Object containing filter information
  - Headings: H1: Interface: FilterCondition | H3: Properties | H2: Properties | H3: displayString | H3: operation | H3: value

- [Interface: FilterData] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterData.htm): Filter.FilterData
  - Second paragraph: Interface containing information about a Filter on a field
  - Headings: H1: Interface: FilterData | H3: Properties | H2: Properties | H3: conditions | H3: enabled | H3: field | H3: fieldDisplayNameOverride | H3: global | H3: hidden | H3: multiple | H3: pivotOnField | H3: searchNodeToHide | H3: userGlobal | H3: widgetNative | H3: widgetUuid

- [Interface: FilterInfo] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterInfo.htm): Filter.FilterInfo
  - Second paragraph: Can be any value from FILTER_NODE_TYPE
  - Headings: H1: Interface: FilterInfo | H3: Properties | H2: Properties | H3: customData | H3: data | H3: type

- [Interface: FilterStateModificationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateModificationApi.htm): FilterStateModificationApi.FilterStateModificationApi
  - Second paragraph: Refer to FilterStateModificationApiV1
  - Headings: H1: Interface: FilterStateModificationApi | H3: Properties | H2: Properties | H3: updateFilterState | H3: v1

- [Interface: FilterStateModificationApiV1] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateModificationApiV1.htm): FilterStateModificationApi.FilterStateModificationApiV1
  - Second paragraph: Contains an API to allow modification of the filter state on the current list
  - Headings: H1: Interface: FilterStateModificationApiV1 | H3: Properties | H2: Properties | H3: updateFilterState

- [Interface: FilterStateNotificationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateNotificationApi.htm): FilterStateNotificationApi.FilterStateNotificationApi
  - Second paragraph: Refer to FilterStateNotificationApiV1
  - Headings: H1: Interface: FilterStateNotificationApi | H3: Properties | H2: Properties | H3: onFilterStateChange | H3: v1

- [Interface: FilterStateNotificationApiV1] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateNotificationApiV1.htm): FilterStateNotificationApi.FilterStateNotificationApiV1
  - Second paragraph: Contains an API to listen for changes to the filter state on the current list
  - Headings: H1: Interface: FilterStateNotificationApiV1 | H3: Properties | H2: Properties | H3: onFilterStateChange

- [Interface: InteractionApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_InteractionApi.htm): InteractionApi.InteractionApi
  - Headings: H1: Interface: InteractionApi | H3: Properties | H2: Properties | H3: config | H3: customCondition | H3: dashboard | H3: dataSource | H3: fieldTypeRegistry | H3: filterStateModification | H3: filterStateNotification | H3: frameContentHelperApi | H3: itemList | H3: modal | H3: objectManager | H3: outboundTranslation | H3: pageInfo | H3: panel | H3: relativityUrlApi | H3: sampleStateModification | H3: sampleStateNotification | H3: toastNotification | H3: toolbar | H3: widget

- [Interface: ItemListApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListApi.htm): ItemListApi.ItemListApi
  - Second paragraph: Contains APIs to allow item list manipulation and notification of various points in the item list's lifecycle
  - Headings: H1: Interface: ItemListApi | H3: Properties | H2: Properties | H3: getSelectedKeys | H3: onBrowserChange | H3: onDashboardChange | H3: onHighlightedRowChange | H3: onItemListPopulated | H3: onSelectedCountChange | H3: onTotalCountChange | H3: onViewChange | H3: requestItemListDataReload

- [Interface: ItemListData] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListData.htm): DataSourceApi.ItemListData
  - Second paragraph: The data to be displayed in the item list
  - Headings: H1: Interface: ItemListData | H3: Properties | H2: Properties | H3: IDWindow | H3: data | H3: startIndex | H3: totalCount

- [Interface: ItemListDataSource] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListDataSource.htm): DataSourceApi.ItemListDataSource
  - Second paragraph: Contains the item list data source APIs that can be overwritten
  - Headings: H1: Interface: ItemListDataSource | H3: Methods | H2: Methods | H3: getData | H3: transformInbound | H3: transformMultiReflectedFields

- [Interface: ItemListDataSourceCallbacks] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListDataSourceCallbacks.htm): DataSourceApi.ItemListDataSourceCallbacks
  - Second paragraph: Callback functions for the item list data source
  - Headings: H1: Interface: ItemListDataSourceCallbacks | H3: Methods | H2: Methods | H3: setItemListListRowKey

- [Interface: ItemListFieldCollection] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListFieldCollection.htm): OutboundTranslationApi.ItemListFieldCollection
  - Second paragraph: Collection of Fields for an associated object
  - Headings: H1: Interface: ItemListFieldCollection | H2: Indexable

- [Interface: ItemListFieldRef] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListFieldRef.htm): FieldRef.ItemListFieldRef
  - Second paragraph: Field metadata
  - Headings: H1: Interface: ItemListFieldRef | H2: Hierarchy | H3: Properties | H2: Properties | H3: AllowGroupBy | H3: AllowHtml | H3: AllowPivot | H3: ArtifactID | H3: AssociativeObjectTypeID | H3: AvfID | H3: Category | H3: ColumnName | H3: ConnectorFieldArtifactID | H3: DataGridEnabled | H3: DisplayName | H3: FalseValue | H3: FieldTreeView | H3: FieldTypeID | H3: FilterType | H3: FormatString | H3: FriendlyName | H3: Guid | H3: Guids | H3: HeaderName | H3: IncludeInTextIndex | H3: IsFilterable | H3: IsLinked | H3: IsReflected | H3: IsRelational | H3: IsSortable | H3: IsSystem | H3: IsVisible | H3: ItemListType | H3: MaxLength | H3: Name | H3: PopupPickerView | H3: SourceFieldArtifactGuids | H3: StaticText | H3: TrueValue | H3: ViewFieldID | H3: Width | H3: Wrapping | H3: artifactID | H3: name

- [Interface: MenuApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_MenuApi.htm): WidgetApi.MenuApi
  - Second paragraph: API passed to WidgetMenuEventHandler
  - Headings: H1: Interface: MenuApi | H3: Properties | H2: Properties | H3: menu | H3: typeName

- [Interface: ModalAction] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ModalAction.htm): ModalApi.ModalAction
  - Second paragraph: Button placed at the bottom of a modal
  - Headings: H1: Interface: ModalAction | H3: Properties | H2: Properties | H3: callback | H3: destructive | H3: disable | H3: label | H3: loading | H3: secondary | H3: tertiary

- [Interface: ModalApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ModalApi.htm): ModalApi.ModalApi
  - Second paragraph: Contains APIs to allow the opening of a modal for the current list
  - Headings: H1: Interface: ModalApi | H3: Properties | H2: Properties | H3: confirm | H3: openCustomModal | H3: openExternalModal

- [Interface: ObjectManagerApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerApi.htm): ObjectManagerApi.ObjectManagerApi
  - Second paragraph: Allows developers to get the current Object Manager request information
  - Headings: H1: Interface: ObjectManagerApi | H3: Methods | H2: Methods | H3: getCurrentStateQueryRequest

- [Interface: ObjectManagerData] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerData.htm): DataSourceApi.ObjectManagerData
  - Second paragraph: The collection of data returned from the Object Manager
  - Headings: H1: Interface: ObjectManagerData | H3: Properties | H2: Properties | H3: CurrentStartIndex | H3: Fields | H3: IDWindow | H3: ObjectType | H3: Objects | H3: ResultCount | H3: SampleDetails | H3: TotalCount | H3: extendedData

- [Interface: ObjectManagerObject] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerObject.htm): DataSourceApi.ObjectManagerObject
  - Second paragraph: Used to identify an object from the Object Manager
  - Headings: H1: Interface: ObjectManagerObject | H3: Properties | H2: Properties | H3: ArtifactID | H3: Values

- [Interface: ObjectManagerReadRequest] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerReadRequest.htm): ObjectManagerApi.ObjectManagerReadRequest
  - Headings: H1: Interface: ObjectManagerReadRequest | H3: Properties | H2: Properties | H3: Fields | H3: object

- [Interface: ObjectManagerReadResponse] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerReadResponse.htm): ObjectManagerApi.ObjectManagerReadResponse
  - Headings: H1: Interface: ObjectManagerReadResponse | H3: Properties | H2: Properties | H3: FieldValues | H3: ObjectVersionToken | H3: object

- [Interface: ObjectManagerRequest] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerRequest.htm): ObjectManagerApi.ObjectManagerRequest
  - Second paragraph: Request information sent to Object Manager
  - Headings: H1: Interface: ObjectManagerRequest | H3: Properties | H2: Properties | H3: activeArtifactId | H3: cancellable | H3: condition | H3: convertNumberFieldValuesToString | H3: executingSavedSearchId | H3: executingViewId | H3: fields | H3: includeIdWindow | H3: isAdHocQuery | H3: longTextBehavior | H3: objectType | H3: queryHint | H3: rankSortOrder | H3: relationalField | H3: rowCondition | H3: sampleParameters | H3: searchProviderCondition | H3: sorts

- [Interface: ObjectManagerSort] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerSort.htm): OutboundTranslationApi.ObjectManagerSort
  - Second paragraph: Used in ObjectManager calls to sort data
  - Headings: H1: Interface: ObjectManagerSort | H3: Properties | H2: Properties | H3: Direction | H3: FieldIdentifier

- [Interface: ObjectManagerUpdateRequest] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerUpdateRequest.htm): ObjectManagerApi.ObjectManagerUpdateRequest
  - Headings: H1: Interface: ObjectManagerUpdateRequest | H3: Properties | H2: Properties | H3: FieldValues | H3: ObjectVersionToken | H3: object

- [Interface: ObjectManagerUpdateResponse] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerUpdateResponse.htm): ObjectManagerApi.ObjectManagerUpdateResponse
  - Headings: H1: Interface: ObjectManagerUpdateResponse | H3: Properties | H2: Properties | H3: EventHandlerStatuses

- [Interface: ObjectType] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectType.htm): DataSourceApi.ObjectType
  - Second paragraph: Used to identify an object type
  - Headings: H1: Interface: ObjectType | H3: Properties | H2: Properties | H3: ArtifactID | H3: ArtifactTypeID | H3: Guids | H3: Name

- [Interface: OutboundTranslationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_OutboundTranslationApi.htm): OutboundTranslationApi.OutboundTranslationApi
  - Second paragraph: Refer to OutboundTranslationApiV1
  - Headings: H1: Interface: OutboundTranslationApi | H3: Properties | H2: Properties | H3: translateFilterTreeToQueryConditions | H3: translateItemListFiltersToObjectManagerCondition | H3: translateSearchFiltersAndViewToObjectManagerCondition | H3: translateSortsToSortConditions | H3: v1

- [Interface: OutboundTranslationApiV1] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_OutboundTranslationApiV1.htm): OutboundTranslationApi.OutboundTranslationApiV1
  - Second paragraph: Contains APIs to translate filters conditions into objects to be used for Object Manager queries
  - Headings: H1: Interface: OutboundTranslationApiV1 | H3: Properties | H2: Properties | H3: translateFilterTreeToQueryConditions | H3: translateSortsToSortConditions

- [Interface: PageInfoApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PageInfoApi.htm): PageInfoApi.PageInfoApi
  - Second paragraph: Refer to PageInfoApiV1
  - Headings: H1: Interface: PageInfoApi | H3: Properties | H2: Properties | H3: getFilters | H3: getRelationalField | H3: getSampleState | H3: getSorts | H3: v1

- [Interface: PageInfoApiV1] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PageInfoApiV1.htm): PageInfoApi.PageInfoApiV1
  - Second paragraph: Interface that returns information related to the current page
  - Headings: H1: Interface: PageInfoApiV1 | H3: Properties | H2: Properties | H3: getActiveSearchInfo | H3: getCurrentBrowser | H3: getFilters | H3: getRelationalField | H3: getSampleState | H3: getSorts | H3: onRelationalFieldChange

- [Interface: PanelApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PanelApi.htm): PanelApi.PanelApi
  - Second paragraph: Contains APIs to allow panel expand and collapse
  - Headings: H1: Interface: PanelApi | H3: Properties | H2: Properties | H3: collapsePanels | H3: createComponentPanel | H3: createExternalPanel | H3: expandPanels | H3: hidePanels | H3: showPanels | H3: updateExternalPanel

- [Interface: PivotOnCondition] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PivotOnCondition.htm): Filter.PivotOnCondition
  - Headings: H1: Interface: PivotOnCondition | H3: Properties | H2: Properties | H3: operation | H3: value

- [Interface: QueryTranslationResponse] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_QueryTranslationResponse.htm): OutboundTranslationApi.QueryTranslationResponse
  - Second paragraph: The conditions used to make the query request
  - Headings: H1: Interface: QueryTranslationResponse | H3: Properties | H2: Properties | H3: conditionFilter | H3: rowFilter | H3: searchProviderFilter

- [Interface: RelativityHttpClient] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_RelativityHttpClient.htm): ConvenienceApi.RelativityHttpClient
  - Second paragraph: Allows developers to send requests to internal Relativity APIs or external non-Relativity APIs
  - Headings: H1: Interface: RelativityHttpClient | H3: Properties | H2: Properties | H3: delete | H3: get | H3: getCancellationToken | H3: keplerCallLRP | H3: keplerDelete | H3: keplerGet | H3: keplerPatch | H3: keplerPost | H3: keplerPut | H3: makeRelativityBaseRequestOptions | H3: makeRelativityRelativeUrl | H3: makeRelativityRestBaseRequestOptions | H3: makeRelativityRestRelativeUrl | H3: patch | H3: post | H3: put

- [Interface: SampleDetails] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleDetails.htm): SampleStateNotificationApi.SampleDetails
  - Second paragraph: Response from SampleStateNotificationApi
  - Headings: H1: Interface: SampleDetails | H3: Properties | H2: Properties | H3: SampleSize | H3: Token | H3: UniverseSize

- [Interface: SampleExistingToken] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleExistingToken.htm): ObjectManagerApi.SampleExistingToken
  - Second paragraph: Sampling information used for existing samples
  - Headings: H1: Interface: SampleExistingToken | H3: Properties | H2: Properties | H3: existingToken

- [Interface: SampleParameters] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleParameters.htm): SampleStateNotificationApi.SampleParameters
  - Second paragraph: Parameters to be sent to SampleStateModificationApi
  - Headings: H1: Interface: SampleParameters | H3: Properties | H2: Properties | H3: browserNodeID | H3: confidenceLevel | H3: fixedSampleSize | H3: marginOfError | H3: samplingPercentage

- [Interface: SampleStateModificationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleStateModificationApi.htm): SampleStateModificationApi.SampleStateModificationApi
  - Second paragraph: Contains an API to modify the sampling parameters of the current list
  - Headings: H1: Interface: SampleStateModificationApi | H3: Properties | H2: Properties | H3: updateSampleState

- [Interface: SampleStateNotificationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleStateNotificationApi.htm): SampleStateNotificationApi.SampleStateNotificationApi
  - Second paragraph: Contains APIs to listen for changes to the sample state of the current list
  - Headings: H1: Interface: SampleStateNotificationApi | H3: Properties | H2: Properties | H3: onSampleStateChange

- [Interface: SearchIndex] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SearchIndex.htm): ObjectManagerApi.SearchIndex
  - Second paragraph: Search Index information
  - Headings: H1: Interface: SearchIndex | H3: Properties | H2: Properties | H3: ArtifactID

- [Interface: SearchProviderCondition] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SearchProviderCondition_1.htm): OutboundTranslationApi.SearchProviderCondition
  - Second paragraph: Contains the parameters used to execute a query through a search provider
  - Headings: H1: Interface: SearchProviderCondition | H3: Properties | H2: Properties | H3: artifactId | H3: input | H3: searchProviderBooleanOperator

- [Interface: SearchProviderCondition] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SearchProviderCondition.htm): ObjectManagerApi.SearchProviderCondition
  - Second paragraph: Search Provider Condition information
  - Headings: H1: Interface: SearchProviderCondition | H3: Properties | H2: Properties | H3: input | H3: isUnionSearch | H3: searchIndex

- [Interface: SortMetadata] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SortMetadata.htm): PageInfoApi.SortMetadata
  - Second paragraph: Interface that returns sort metadata
  - Headings: H1: Interface: SortMetadata | H3: Properties | H2: Properties | H3: Direction | H3: FieldIdentifier | H3: Order

- [Interface: ToastNotificationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToastNotificationApi.htm): ToastNotificationApi.ToastNotificationApi
  - Second paragraph: Allows developers to display toast notifications in the application
  - Headings: H1: Interface: ToastNotificationApi | H3: Properties | H2: Properties | H3: createAndShowErrorToast | H3: createAndShowInformationToast | H3: createAndShowSuccessToast | H3: createAndShowWarningToast | H3: createToast | H3: hideToast | H3: showToast

- [Interface: ToolbarApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarApi.htm): ToolbarApi.ToolbarApi
  - Second paragraph: Refer to ToolbarApiV1
  - Headings: H1: Interface: ToolbarApi | H3: Properties | H2: Properties | H3: createToolbarContent | H3: hideToolbar | H3: modifyToolbarContent | H3: showToolbar | H3: v1

- [Interface: ToolbarApiV1] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarApiV1.htm): ToolbarApi.ToolbarApiV1
  - Second paragraph: Contains APIs to allow toolbar creation, modification, and adjust visibility
  - Headings: H1: Interface: ToolbarApiV1 | H3: Properties | H2: Properties | H3: createToolbarContent | H3: getToolbarState | H3: hideAllToolbars | H3: hideToolbar | H3: modifyToolbarContent | H3: showAllToolbars | H3: showToolbar

- [Interface: ToolbarContent] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarContent.htm): ToolbarApi.ToolbarContent
  - Second paragraph: HTML elements to place in the center slot
  - Headings: H1: Interface: ToolbarContent | H3: Properties | H2: Properties | H3: center | H3: cssClass | H3: dominantSlot | H3: left | H3: right | H3: useRawElements

- [Interface: ToolbarFactory] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarFactory.htm): ToolbarApi.ToolbarFactory
  - Second paragraph: A factory function that modifies ToolbarContent
  - Headings: H1: Interface: ToolbarFactory | H2: Callable | H3: ToolbarFactory

- [Interface: ToolbarStateItem] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarStateItem.htm): ToolbarApi.ToolbarStateItem
  - Second paragraph: A representation of the state of a toolbar.
  - Headings: H1: Interface: ToolbarStateItem | H3: Properties | H2: Properties | H3: cssClass | H3: hidden | H3: id

- [Interface: UtilitiesApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_UtilitiesApi.htm): ConvenienceApi.UtilitiesApi
  - Second paragraph: Utility functions made available for scripts
  - Headings: H1: Interface: UtilitiesApi | H3: Properties | H2: Properties | H3: sanitize

- [Interface: View] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_View.htm): View.View
  - Second paragraph: View of a List Page.  Example: in the Documents tab, "My Checked Out Batches"
  - Headings: H1: Interface: View | H3: Properties | H2: Properties | H3: AllConditionCount | H3: ArtifactId | H3: DashboardArtifactId | H3: FieldsIds | H3: GroupDefinitionFieldName | H3: HasConditions | H3: InlineEditingEnabled | H3: Name | H3: QueryHint | H3: RenderLinks | H3: SavedSearchConditionCount | H3: Sorts

- [Interface: WidgetApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetApi.htm): WidgetApi.WidgetApi
  - Second paragraph: Contains APIs to allow registration for a widget type and creation/deletion of widgets on a dashboard
  - Headings: H1: Interface: WidgetApi | H3: Properties | H2: Properties | H3: addOrUpdateWidget | H3: deleteWidget | H3: getWidgetIDs | H3: onWidgetDelete | H3: onWidgetMenuCreate | H3: registerWidgetType

- [Interface: WidgetDeleteEventHandler] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetDeleteEventHandler.htm): WidgetApi.WidgetDeleteEventHandler
  - Headings: H1: Interface: WidgetDeleteEventHandler | H2: Callable | H3: WidgetDeleteEventHandler

- [Interface: WidgetFactory] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetFactory.htm): WidgetApi.WidgetFactory
  - Second paragraph: Contains a factory function to create a WidgetInstance object
  - Headings: H1: Interface: WidgetFactory | H2: Callable | H3: WidgetFactory

- [Interface: WidgetInstance] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetInstance.htm): WidgetApi.WidgetInstance
  - Second paragraph: Data model for each Widget on the dashboard
  - Headings: H1: Interface: WidgetInstance | H3: Properties | H2: Properties | H3: menu | H3: title | H3: wgtRef

- [Interface: WidgetItem] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetItem.htm): WidgetApi.WidgetItem
  - Second paragraph: Data model for each menu item in the WidgetMenu
  - Headings: H1: Interface: WidgetItem | H3: Properties | H2: Properties | H3: icon | H3: name | H3: onClick | H3: type | H3: value | H3: visible

- [Interface: WidgetMenu] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetMenu.htm): WidgetApi.WidgetMenu
  - Second paragraph: Data model for the hamburger menu in the corner of each Widget
  - Headings: H1: Interface: WidgetMenu | H3: Properties | H2: Properties | H3: items | H3: title | H3: visible

- [Interface: WidgetMenuEventHandler] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetMenuEventHandler.htm): WidgetApi.WidgetMenuEventHandler
  - Headings: H1: Interface: WidgetMenuEventHandler | H2: Callable | H3: WidgetMenuEventHandler

- [Interface: WidgetStateInfo] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetStateInfo.htm): WidgetApi.WidgetStateInfo
  - Second paragraph: Data model for a Widget's state
  - Headings: H1: Interface: WidgetStateInfo | H2: Indexable | H3: Properties | H2: Properties | H3: height_px | H3: settings | H3: type | H3: width_pct

- [Interface: WidgetStateSettings] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetStateSettings.htm): WidgetApi.WidgetStateSettings
  - Second paragraph: Data model for a Widget's state settings
  - Headings: H1: Interface: WidgetStateSettings | H2: Indexable | H3: Properties | H2: Properties | H3: id | H3: title

- [Lists Interaction API Classes] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Classes.htm)
  - Headings: H1: Lists Interaction API Classes

- [Lists Interaction API Enums] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Enums.htm)
  - Headings: H1: Lists Interaction API Enums

- [Lists Interaction API Interfaces] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Interfaces.htm)
  - Headings: H1: Lists Interaction API Interfaces

- [Lists Interaction API Modules] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Modules.htm)
  - Headings: H1: Lists Interaction API Modules

- [Module: Browser] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_Browser.htm): Ƭ BrowserStateMap: { [key in BrowserID]?: BrowserState }
  - Second paragraph: Map of BrowserID to BrowserState
  - Headings: H1: Module: Browser | H3: Enumerations | H3: Interfaces | H3: Type Aliases | H2: Type Aliases | H3: BrowserStateMap

- [Module: ConfigApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ConfigApi.htm): Ƭ EventHandlerFunction: (...params: unknown[]) => void
  - Second paragraph: The handler to be executed when an event is triggered
  - Headings: H1: Module: ConfigApi | H3: Interfaces | H3: Type Aliases | H2: Type Aliases | H3: EventHandlerFunction

- [Module: ConvenienceApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ConvenienceApi.htm)
  - Headings: H1: Module: ConvenienceApi | H3: Interfaces

- [Module: CustomConditionApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_CustomConditionApi.htm): Ƭ CustomConditionCallback: (filterData: FilterData) => Promise<CustomConditionCallbackResponse>
  - Second paragraph: Promise<CustomConditionCallbackResponse>
  - Headings: H1: Module: CustomConditionApi | H3: Enumerations | H3: Interfaces | H3: Type Aliases | H2: Type Aliases | H3: CustomConditionCallback

- [Module: DashboardApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_DashboardApi.htm)
  - Headings: H1: Module: DashboardApi | H3: Interfaces

- [Module: DataSourceApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_DataSourceApi.htm): Ƭ ArtifactIdentifier: Object
  - Second paragraph: Workspace level object identification
  - Headings: H1: Module: DataSourceApi | H3: Enumerations | H3: Interfaces | H3: Type Aliases | H2: Type Aliases | H3: ArtifactIdentifier | H3: CustomFormatterOptions | H3: DataSource | H3: FieldValue | H3: FormatterDataItem | H3: ItemListDataSourceFactoryFunction | H3: SetListFilterDataFunction

- [Module: FieldRef] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FieldRef.htm)
  - Headings: H1: Module: FieldRef | H3: Interfaces

- [Module: FieldTypeRegistryApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FieldTypeRegistryApi.htm)
  - Headings: H1: Module: FieldTypeRegistryApi | H3: Interfaces

- [Module: Filter] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_Filter.htm)
  - Headings: H1: Module: Filter | H3: Enumerations | H3: Classes | H3: Interfaces

- [Module: FilterStateModificationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FilterStateModificationApi.htm)
  - Headings: H1: Module: FilterStateModificationApi | H3: Enumerations | H3: Interfaces

- [Module: FilterStateNotificationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FilterStateNotificationApi.htm): Ƭ FilterStateChangeFunction: (newFilterState: FilterState) => void
  - Second paragraph: Ƭ FilterStateChangeFunctionV1: (filterObjects: FilterBase) => void
  - Headings: H1: Module: FilterStateNotificationApi | H3: Interfaces | H3: Type Aliases | H2: Type Aliases | H3: FilterStateChangeFunction | H3: FilterStateChangeFunctionV1

- [Module: InteractionApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_InteractionApi.htm)
  - Headings: H1: Module: InteractionApi | H3: Interfaces

- [Module: ItemListApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ItemListApi.htm)
  - Headings: H1: Module: ItemListApi | H3: Interfaces

- [Module: ModalApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ModalApi.htm): Ƭ OpenModalHandler: (dialogOpenResult: DialogCancellableOpenResult) => void
  - Second paragraph: The handler callback that is triggered when a modal is opened
  - Headings: H1: Module: ModalApi | H3: Interfaces | H3: Type Aliases | H2: Type Aliases | H3: OpenModalHandler | H3: RWCModalSize

- [Module: ObjectManagerApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ObjectManagerApi.htm)
  - Headings: H1: Module: ObjectManagerApi | H3: Enumerations | H3: Interfaces

- [Module: OutboundTranslationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_OutboundTranslationApi.htm)
  - Headings: H1: Module: OutboundTranslationApi | H3: Interfaces

- [Module: PageInfoApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_PageInfoApi.htm)
  - Headings: H1: Module: PageInfoApi | H3: Interfaces

- [Module: PanelApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_PanelApi.htm)
  - Headings: H1: Module: PanelApi | H3: Interfaces

- [Module: SampleStateModificationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_SampleStateModificationApi.htm)
  - Headings: H1: Module: SampleStateModificationApi | H3: Interfaces

- [Module: SampleStateNotificationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_SampleStateNotificationApi.htm): Ƭ SampleDetailsMap: Map<BrowserID, SampleDetails | undefined>
  - Second paragraph: Associates each SampleDetails object with a corresponding BrowserID
  - Headings: H1: Module: SampleStateNotificationApi | H3: Classes | H3: Interfaces | H3: Type Aliases | H2: Type Aliases | H3: SampleDetailsMap | H3: SampleParametersMap | H3: SampleStateChangeFunction

- [Module: ToastNotificationApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ToastNotificationApi.htm)
  - Headings: H1: Module: ToastNotificationApi | H3: Interfaces

- [Module: ToolbarApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ToolbarApi.htm): Ƭ ToolbarSlotName: "header" | "dashboard" | "footer"
  - Second paragraph: The location on the page to create the toolbar
  - Headings: H1: Module: ToolbarApi | H3: Enumerations | H3: Interfaces | H3: Type Aliases | H2: Type Aliases | H3: ToolbarSlotName

- [Module: View] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_View.htm)
  - Headings: H1: Module: View | H3: Interfaces

- [Module: WidgetApi] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_WidgetApi.htm)
  - Headings: H1: Module: WidgetApi | H3: Interfaces

- [Relativity Lists Interaction API] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Relativity_Lists_Interaction.htm)
  - Headings: H1: Relativity Lists Interaction API | H3: Modules

- [Relativity Lists Interaction APIs] (https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Relativity_Lists_Interaction_APIs.htm): Relativity Lists provides a robust offering of APIs to allow developers to write custom code to extend the functionality of their list pages. By creating an interaction script, developers can subscribe to events, usually beginning with an on prefix (e.g. onItemListPopulated), or access additional service APIs that allow a variety of functionality to be executed, including custom widget registration, custom modal creation, and data source overrides.
  - Second paragraph: The APIs are arranged into objects based on their function. You can start by looking at the 2 top level objects in which all APIs and properties are contained:
  - Headings: H1: Relativity Lists Interaction APIs | H2: Summary | H2: Interaction Script Format | H3: Example Interaction Script | H3: Execution Context | H2: Associating With An Object Type | H2: Migrating a Classic List Page Interaction Script to Relativity.Lists | H3: Testing A Migrated Interaction Script | H3: Initializer API | H3: Event-based APIs | H3: General service APIs | H3: Common Migration Scenarios | H2: Script Caching | H3: Modules


### Logging
- [External Logging] (https://platform.relativity.com/RelativityaiR/Content/Logging/External_Logging.htm): Using an external, third-party logging provider to log from a custom Relativity application
  - Second paragraph: In most cases, external logging is the preferred logging solution for production application over using the IAPILog Interface for logging.
  - Headings: H1: Using External Logging | H2: Prerequisites | H2: Scope | H2: Data Security | H2: Logging Instance Settings | H2: Logging Packages | H2: Logging | H2: Troubleshooting

- [Logging from Relativity applications] (https://platform.relativity.com/RelativityaiR/Content/Logging/Log_from_a_Relativity_application.htm): Writing log output from your custom applications
  - Second paragraph: The External Logging approach provides an optimal experience with near real-time telemetry, logging access for development workflows, and finer logging control.  Because of these benefits, the External Logging approach is recommended over the IAPILog Interface, despite the IAPILog Interface's slightly lower barrier to entry.
  - Headings: H1: Logging from Relativity applications | H3: Data Logging Security

- [Using the IAPILog Interface for logging] (https://platform.relativity.com/RelativityaiR/Content/Logging/IAPILog_Interface_Logging.htm): Using the IAPILog Interface for logging from a custom Relativity application
  - Second paragraph: Before using logging in a custom application, make sure logging is enabled in Relativity to write to an appropriate sink. If you want to use the defaults, make sure the default configuration row in the RelativityLogging.Configuration table is set to True (1). This enables logging to the EDDSLogging.RelativityLogs table at the Error (4) level. .
  - Headings: H1: Using the IAPILog Interface for logging | H2: Before you begin | H2: IAPILog interface | H2: Add loggers using API helpers | H2: Add custom metadata to loggers | H2: Best practices


### Mass Operations
- [Mass Operations (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_API.htm): Use the Mass Operations .NET API to bulk edit, move, delete, replace, tally, export, save as list, or copy documents and RDOs, with code samples.
  - Second paragraph: These code samples utilize a .NET service proxy. See the topic Client .NET proxy for details on working with a service proxy.
  - Headings: H1: Mass Operations (.NET) | H2: Code Samples | H3: Mass copy | H3: Mass move | H3: Mass edit | H3: Mass delete | H3: Mass replace | H3: Save-as-list | H3: Tally/sum/average | H3: Export to file | H3: Return state information for a specific operation | H3: Cancel a specific operation | H2: Considerations

- [Mass Operations (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_Service.htm): Use the Mass Operations REST service (relativity-massoperation) for bulk processing of documents and RDOs, with its base route, methods, and request models.
  - Second paragraph: See the topic Mass Operations REST API Reference for reference content for the relativity-massoperation REST service.
  - Headings: H1: Mass Operations (REST)

- [Mass Operations .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/MassOperationsNETAPI.html): Mass Operations .NET API Reference

- [Mass Operations .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_NET_API_Reference.htm): Browse the Mass Operations .NET API reference for the Relativity.MassOperations.SDK, including its interfaces and classes.
  - Headings: H1: Mass Operations .NET API Reference | H2: Relativity.MassOperations.SDK

- [Mass Operations Business Domain] (https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations.htm): Find the Mass Operations landing page, with supported bulk operations, considerations, links to the .NET and REST content, and version history.
  - Headings: H1: Mass Operations | H2: Considerations | H2: Current Mass Operations API content | H2: Version History

- [Mass Operations REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_REST_API_Reference.htm): Browse the Mass Operations REST API reference for the relativity-massoperation service and its endpoints.
  - Headings: H1: Mass Operations REST API Reference | H2: relativity-massoperation

- [Mass Operations REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/MassOperationsRESTAPI.html): Mass Operations REST Reference


### Notifications
- [Notifications] (https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications.htm): Learn about the Relativity Notifications APIs for sending email, including prerequisites, sender behavior, and links to the .NET and REST topics.
  - Second paragraph: In order to call methods in this API:
  - Headings: H1: Notifications | H2: Current Notifications API content | H2: Using the Notifications Service | H3: Prerequisites | H3: Sender | H3: Sending Email Notifications | H2: Troubleshooting | H2: Version History

- [Notifications (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications__.NET_.htm): Use the Relativity.Notifications .NET API to send email notifications through the Relativity SMTP client, with the EmailNotificationRequest object and a code sample.
  - Second paragraph: The Relativity.Notifications.SDK contains this API. For compatibility and package installation instructions, see Download the SDKs and NuGet packages.
  - Headings: H1: Notifications (.NET) | H2: Code Samples

- [Notifications (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications__REST_.htm): Use the Notifications REST service to send email notifications through Relativity, with the endpoint URL and sample JSON request and response.
  - Second paragraph: This service resides at the following URL:
  - Headings: H1: Notifications (REST) | H2: Code Samples

- [Notifications .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/NotificationsNETAPI.html): Notifications .NET API Reference

- [Notifications .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications_NET_API_Reference.htm): Browse the Notifications .NET API reference for the Relativity.Notifications.SDK, including its interfaces and classes.
  - Headings: H1: Notifications .NET API Reference | H2: Relativity.Notifications.SDK


### Object Manager
- [Migrating code to the Object Manager API] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Migrating_code_to_the_Object_Manager_API.htm): Use this migration guide to upgrade legacy code using older versions of the Object Manager API.
  - Second paragraph: You can easily migrate your existing code to the Object Manager API. The following list outlines the differences between the Object Manager and Query Object Manager APIs:
  - Headings: H1: Migrating code to the Object Manager API | H2: Legacy code sample using the Object Query Manager API | H2: Updated code sample using the Object Manager API

- [Object Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_API.htm): Object Manager API exposes CRUDQ and mass operations for Relativity Dynamic Objects (RDOs) through .NET. Except for the create method, it supports these operations on Document objects. It also exposes methods for exporting document fields, including long text fields.
  - Second paragraph: You can also use the Object Manager service through REST. However, the REST endpoints do not support cancellation tokens or progress indicators. For more information, see Object Manager (REST).
  - Headings: H1: Object Manager (.NET) | H2: Fundamentals for the Object Manager service | H3: Methods | H3: Classes for general functionality | H3: Classes for retrieving dependency lists | H3: Classes for mass operations | H3: Classes for working with  hydrated objects | H3: Classes used for export operations | H3: Exceptions | H2: Guidelines for using the Object Manager service | H3: Rate limit | H3: Use tokens with long text fields | H3: IObjectManager instance | H3: Supported field types | H3: Propagation | H3: Event handlers | H3: Indexers on the RelativityObject class | H2: Create an RDO and its specified fields | H2: Mass create RDOs | H2: Retrieve field values for a Document object or RDO | H2: Update field values on a Document object or RDO | H3: Update field values on a single object | H3: Update field values on a multiple object | H2: Update a long text field using an input stream in .NET | H2: Mass update Document objects or RDOs | H3: Mass update operation using query conditions | H3: Mass update operation using identifiers | H3: Mass update operation using objects | H2: Retrieve a list of object dependencies | H2: Delete a Document object or RDO | H2: Mass delete Document objects or RDOs | H3: Mass delete operation using query conditions | H3: Mass delete operation using identifiers | H2: Query for Relativity objects | H3: Parameter descriptions for query methods | H2: Export API | H3: Export API workflow | H3: Set up an export job | H3: Retrieve objects | H3: Stream text | H3: Export API code sample | H3: Export API Helper library

- [Object Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_service.htm): Object Manager service exposes CRUDQ and mass operation endpoints for Relativity Dynamic Objects (RDOs) through REST. Except for the create endpoint, it supports these operations on Document objects. It also exposes endpoints for exporting document fields, including long text fields.
  - Second paragraph: You can also use the Object Manager service through .NET, which supports the use of progress indicators and cancellation tokens for queries. For more information, see Object Manager (.NET).
  - Headings: H1: Object Manager (REST) | H2: Rate limit | H3: Testing the rate limit | H2: Guidelines for the Object Manager service | H2: Postman sample file | H2: Client code sample | H2: Create an RDO | H2: Mass create RDOs | H2: Retrieve field values for a Document object or RDO | H2: Update fields on a Document object or RDO | H2: Update a long text field using an input stream | H3: Update a long text field using Postman | H2: Mass update Document objects or RDOs | H2: Retrieve a list of object dependencies | H2: Delete a Document object or RDO | H2: Mass delete Document objects or RDOs | H2: Query for Relativity objects | H2: Export API | H3: Set up an export job | H3: Retrieve objects | H3: Stream text | H2: Status and Error Codes

- [Object Manager Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager.htm): Find the Object Manager landing page for creating, reading, updating, deleting, and querying Relativity objects, with changelog, content links, and version history.
  - Headings: H1: Object Manager | H2: Current Object Manager API content | H2: Version History

- [Object Manager REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_REST_API_Reference.htm): Browse the Object Manager REST API reference for the Relativity.ObjectManager service and its endpoints.
  - Headings: H1: Object Manager REST API Reference | H2: Relativity.ObjectManager

- [Object Manager REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/ObjectManagerRESTAPI.html): Object Manager REST Reference

- [Object Manager SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Relativity_Object_Manager_NET_API_Reference.htm): Browse the Relativity Object Manager SDK .NET API reference for the Relativity.ObjectManager.SDK namespace.
  - Headings: H1: Object Manager SDK .NET API Reference | H2: Relativity.ObjectManager.SDK

- [Object Manager SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/RelativityObjectManagerNETAPI.html): Object Manager SDK .NET API Reference

- [Object Manager SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/ObjectManagerNETAPI.html): Object Manager SDK .NET API Reference

- [Object Manager SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_NET_API_Reference.htm): Browse the Object Manager SDK .NET API reference for the Relativity.ObjectManager.SDK, including its interfaces and classes.
  - Headings: H1: Object Manager SDK .NET API Reference | H2: Relativity.ObjectManager.SDK


### Object Model
- [Choice Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Choice_Manager_API.htm): The Choice Manager API supports CRUD operations on choices and related mass operations in .NET. It also supports sorting, moving choices in lists, and retrieving highlight colors and parent choices or fields.
  - Second paragraph: The Choice Manager API exposes multiple operations you can use to programmatically manage choices in your Relativity environment. It includes the following features:
  - Headings: H1: Choice Manager (.NET) | H2: Fundamentals for the Choice Manager API | H3: Guidelines for the Choice Manager API | H2: Create a single choice | H2: Mass create choices | H2: Read a choice | H2: Update a choice without a version check | H2: Update a choice with a version check | H2: Update multiple choices | H2: Delete a choice | H2: Delete multiple choices | H2: Sort choices | H2: Move choices to start or end of list | H2: Move choices after a specific choice in a list | H2: Retrieve a list of available parents | H2: Retrieve a list of available colors

- [Choice Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Choice_Manager_service.htm): The Choice Manager service supports CRUD operations on choices and related mass operations in REST. It also supports sorting, moving choices in lists, and retrieving highlight colors and parent choices or fields.
  - Second paragraph: The Choice Manager service exposes multiple operations you can use to programmatically manage choices in your Relativity environment. It includes the following features:
  - Headings: H1: Choice Manager (REST) | H2: Guidelines for the Choice Manager service | H3: URLs | H2: Postman sample file | H2: Client code sample | H2: Create a single choice | H2: Mass create choices | H2: Read a choice | H2: Update a choice without a version check | H2: Update a choice with a version check | H2: Mass update choices | H2: Delete a choice | H2: Mass delete choices | H2: Sort choices | H2: Move choices to the beginning or end of a list | H2: Move choices after a specific choice in a list | H2: Retrieve a list of available parents | H3: Retrieve a list of parents for a choice | H3: Retrieve a list of parents for a field | H2: Retrieve a list of available colors

- [Document File Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Document_File_Manager_API.htm): The Document File Manager API exposes methods for downloading native, image, and produced image files associated with documents in Relativity through .NET. It also supports retrieving file information, such as GUID, name, type, size, and others.
  - Second paragraph: Sample use cases for the Document File Manager API include the implementing the following functionality:
  - Headings: H1: Document File Manager (.NET) | H2: Fundamentals for the Document File Manager API | H2: Retrieve document file information | H2: Download files | H3: Download a file by GUID | H3: Download a native file by Document Artifact ID

- [Document File Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Document_File_Manager_service.htm): The Document File Manager service exposes endpoints for downloading native, image, and produced image files associated with documents in Relativity through REST. It also supports retrieving file information, such as GUID, name, type, size, and others.
  - Second paragraph: Sample use cases for the Document File Manager API include the implementing the following functionality:
  - Headings: H1: Document File Manager (REST) | H2: Guidelines for the Document File Manager service | H3: URLs | H2: Client code sample | H2: Retrieve document file information | H2: Download files | H3: Download a file by GUID | H3: Download a native file by Document Artifact ID

- [Field Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Field_Manager_API.htm): The Field Manager API provides multiple methods for programmatically working with field types supported by Relativity. This API supports CRUD operations on fields and includes helper methods for retrieving additional information about fields in .NET.
  - Second paragraph: Sample use cases for the Field Manager API include programmatically adding new fields to a custom application as data requirements change, or creating new keyboard shortcuts for fields to support modified workflows for users.
  - Headings: H1: Field Manager (.NET) | H2: Fundamentals for Field Manager API | H2: Guidelines for the Field Manager API | H3: Supported field types | H3: Helper methods | H3: Relational fields | H3: Overlay behavior | H3: Filter types | H3: Source property | H3: Formatting fields | H2: Create a field | H2: Read a field | H2: Update a field | H2: Delete a field | H2: Retrieve available object types | H2: Retrieve available views for an object type | H2: Retrieve available fields for propagation | H2: Retrieve object types for a single object field | H2: Retrieve object types for a multiple object field | H2: Retrieve keyboard shortcuts | H2: Retrieve valid keys | H2: Retrieve the order of relational field icons

- [Field Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Field_Manager_service.htm): The Field Manager service provides multiple endpoints for programmatically working with field types supported by Relativity. This service supports CRUD operations on fields and includes helper methods for retrieving additional information about fields in REST.
  - Second paragraph: Sample use cases for the Field Manager service include programmatically adding new fields to a custom application as data requirements change, or creating new keyboard shortcuts for fields to support modified workflows for users.
  - Headings: H1: Field Manager (REST) | H2: Guidelines for the Field Manager service | H3: URLs | H3: Supported field types | H3: Helper endpoints | H3: Relational fields | H3: Overlay behavior | H3: Filter types | H3: Source property | H3: Formatting fields | H2: Client code sample | H2: Postman sample file | H2: Create a field | H2: Read a field | H2: Update a field | H2: Delete a field | H2: Retrieve available object types | H2: Retrieve available views for an object type | H2: Retrieve available fields for propagation | H2: Retrieve object types for a single object field | H2: Retrieve object types for a multiple object field | H2: Retrieve keyboard shortcuts | H2: Retrieve valid keys | H2: Retrieve the order of relational field icons

- [File Field Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/File_Field_Manager_API.htm): The File Field Manager API exposes a service for uploading and downloading files linked to file fields in .NET.
  - Second paragraph: As a sample use case, you might leverage this service to create a custom page with links for downloading files from Relativity.
  - Headings: H1: File Field Manager (.NET) | H2: File Field Manager API fundamentals | H2: Sample workflow for file fields | H2: Downloading files from file fields | H2: Uploading files to file fields

- [File Field Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/File_Field_Manager_service.htm): The File Field Manager API exposes a service for uploading and downloading files linked to file fields in REST.
  - Second paragraph: You can also use the File Field Manager through .NET. It supports the use of progress indicators and cancellation tokens in .NET. For more information, see File Field Manager (.NET).
  - Headings: H1: File Field Manager (REST) | H2: Guidelines for the File Field Manager service | H2: Postman sample file | H2: Client code sample | H2: Uploading files to file fields | H2: Downloading files from file fields

- [Object Model .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/ObjectModelNETAPI.html): Object Model .NET API Reference

- [Object Model .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Model_NET_API_Reference.htm): Browse the Object Model .NET API reference for the Relativity.ObjectModel.SDK, including its interfaces and classes.
  - Headings: H1: Object Model .NET API Reference | H2: Relativity.ObjectModel.SDK

- [Object Model Business Domain] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Model.htm): Find the Object Model landing page for defining a custom data model with object types, fields, and choices, with links to the .NET and REST manager topics.
  - Headings: H1: Object Model | H2: Current Object Model API content | H2: Version History

- [Object Type Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Type_Manager_API.htm): The Object Type Manager API exposes methods for programmatically creating custom object types for use in your applications in .NET. It supports for create, read, update, and delete operations on object types, and retrieving parent object types.
  - Second paragraph: As a sample use case, you could use the Object Type Manager API to add new object types to support a custom application that you developed. You might want to implement an application that tracks vendor or customer information and decide to add different object types for each of these items. You could also customize these object types with object rules, event handlers, and mass operations.
  - Headings: H1: Object Type Manager (.NET) | H2: Fundamentals for managing object types | H2: CRUD operations for object types | H3: Create an object type | H3: Read an object type | H3: Update an object type | H3: Delete an object type | H3: Retrieve parent object types

- [Object Type Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Type_Manager_service.htm): The Object Type Manager service exposes endpoints for programmatically creating custom object types for use in your applications in REST. It supports for create, read, update, and delete operations on object types, and retrieving parent object types.
  - Second paragraph: As a sample use case, you could use the Object Type Manager service to add new object types to support a custom application that you developed. You might want to implement an application that tracks vendor or customer information and decide to add different object types for each of these items. These object types could be further customized with object rules, event handlers, and mass operations.
  - Headings: H1: Object Type Manager (REST) | H2: Guidelines for the Object Type Manager service | H3: URLs | H2: Postman sample files | H2: Client code sample | H2: CRUD operations for object types | H3: Create an object type | H3: Read an object type | H3: Update an object type | H3: Delete an object type | H3: Retrieve a parent object types

- [System Artifact Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/System_Artifact_Manager_API.htm): The System Artifact Manager API exposes the ReadArtifactIDAsync() method used to retrieve the Artifact ID of a system artifact in .NET. Use this method when you want to create top-level tabs or object types in a custom application.
  - Second paragraph: You can also use System Artifact Manager API through REST. For more information, see System Artifact Manager (REST).
  - Headings: H1: System Artifact Manager (.NET) | H2: System Artifact Manager API fundamentals | H2: Retrieve the Artifact ID of a system artifact

- [System Artifact Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/System_Artifact_Manager_service.htm): The System Artifact Manager service exposes an endpoint used to retrieve the Artifact ID of a system artifact in REST. Use this endpoint when you want to create top-level tabs or object types in a custom application.
  - Second paragraph: You can also use System Artifact Manager service through .NET. For more information, see System Artifact Manager (REST).
  - Headings: H1: System Artifact Manager (REST) | H2: Guidelines for the System Artifact Manager service | H3: URLs | H2: Client code sample | H2: Read system artifact ID


### OutsideIn
- [OutsideIn .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_OutsideIn/OutsideInNETAPI.html): OutsideIn .NET API Reference

- [OutsideIn .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_OutsideIn/OutsideIn_NET_API_Reference.htm): Browse the OutsideIn .NET API reference for the Relativity.OutsideIn namespace.
  - Headings: H1: OutsideIn .NET API Reference | H2: Relativity.OutsideIn


### Overview
- [Handle Import Service API errors and exceptions] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Overview/Handling_error_codes.htm): Learn the Export Service API error code structure of source, error type, operation, and error number, and how to interpret the codes returned for failed requests and data source errors.
  - Second paragraph: Error codes returned from the Export Service API endpoint has the following structure, [Sources].[Error Types].[Operations].[Error numbers]. For example, JOB.01 is returned when an incorrect total items processed number.
  - Headings: H1: Handle Export Service API errors and exceptions | H2: Error code structure | H3: Sources | H3: Error Types | H3: Operations | H3: Error numbers

- [Handle Import Service API errors and exceptions] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Overview/Handling_error_codes.htm): Learn how the Import Service API reports job level and item level errors, and how to retrieve error codes and messages from the details and item errors endpoints.
  - Second paragraph: Error handling in Import Service returns error codes and error messages:
  - Headings: H1: Handle Import Service API errors and exceptions | H2: Retrieving errors | H2: Error code structure | H3: Resources | H3: Actions | H3: Error types | H3: Error numbers

- [Relativity Export Service API] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Overview/Relativity_Export_Service_API.htm): Learn about the Relativity Export Service API, a REST service for exporting documents, images, PDFs, natives, and RDOs from a workspace, with links to related pages and Relativity.Export.SDK version history.
  - Second paragraph: This service leverages the RESTful API architecture to streamline the creation, configuration, and execution of export jobs, allowing for a seamless data transfer experience.
  - Headings: H1: Relativity Export Service API | H2: Version History | H3: Relativity.Export.SDK

- [Relativity Import Service API] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Overview/Relativity_Import_Service_API.htm): Learn how the Relativity Import Service API, a Kepler service, imports large numbers of documents, images, and RDOs through import jobs and data sources, with links to related pages.
  - Second paragraph: Import Service is delivered as a RAP application installed in Relativity aiR.
  - Headings: H1: Relativity Import Service API | H2: Version History | H3: Relativity.Import.SDK | H3: Relativity.Import.Models.SDK


### Pivot
- [Pivot Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot.htm): Find the Pivot business domain landing page for managing and executing Relativity Pivots, with links to the .NET and REST content and version history.
  - Headings: H1: Pivot | H2: Current Pivot API content | H2: Version History

- [Pivot Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot_Manager_API.htm): Pivot helps you analyze and report trends or patterns in workspace data by querying specific sets of data and summarizing the results. Relativity provides a range of options for querying, calculating, and displaying the data. By using the Pivot APIs in the Relativity Services API, you can extend those options by running queries based on existing Pivot profiles, creating and running custom Pivot queries, and passing query results to another application for deeper analysis and reporting.
  - Second paragraph: Whether you use predefined or custom settings, Relativity provides a range of options for querying, calculating, and displaying the data. By using the Pivot APIs, you can extend those options by running queries based on existing Pivot profiles, creating and running custom Pivot queries, and passing query results to another application—for example, a third-party software application or web-based visualization tool—for deeper analysis and reporting.
  - Headings: H1: Pivot Manager (.NET) | H2: Pivot fundamentals | H2: Create a PivotManager object | H2: Create a Pivot profile | H2: Update a Pivot profile | H2: Run a query based on a Pivot profile | H2: Execute a custom Pivot query | H2: Display query progress | H2: Cancel a query | H2: Work with query results | H2: Export a Pivot query

- [Pivot Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot_Manager_service.htm): The Pivot Manager Service of the Relativity REST API provides operations for working with custom Pivot queries and Pivot profiles. You can use the service to create and run custom Pivot queries and to read and run queries that are based on existing Pivot profiles.
  - Second paragraph: Note that the Pivot Manager service doesn’t provide operations for creating, updating, or deleting Pivot queries that persist in Relativity. This means that you can use the service to create and run a custom query but you can’t store and subsequently update or delete the query or query results in Relativity. Similarly, you can use the service to read an existing Pivot profile and run a query that’s based on the profile, but you can’t create, update, or delete a Pivot profile. Overall, the service is designed to help you transfer data to other applications and tools, such as a third-party software application or web-based visualization tool, for deeper analysis and reporting. For example, you might use the service to implement a Pivot query as part of a larger solution that captures query results, writes the results to a specified table, object, or other location, and then manipulates the results in that location.
  - Headings: H1: Pivot Manager (REST) | H2: Pivot fundamentals | H3: Fields | H3: HTTP headers and status codes | H2: Create a Pivot profile | H2: Read a Pivot profile | H2: Update a Pivot profile | H2: Execute a custom Pivot query | H2: Export a Pivot query | H2: Sample JSON response | H2: Helper operations | H3: getGroupByFieldsForDocuments | H3: getPivotOnFieldsForDocuments

- [Pivot REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/PivotRESTAPI.html): Pivot REST API Reference

- [Pivot REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot_REST_API_Reference.htm): Browse the Pivot REST API reference for the relativity-pivot service and its endpoints.
  - Headings: H1: Pivot REST API Reference | H2: relativity-pivot


### Processing
- [Field Mapping Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Field_Mapping_API.htm): Use the Field Mapping Manager .NET service to retrieve mappable fields and read or update field mappings between Relativity and Invariant for processing.
  - Second paragraph: Currently, this service supports managing only the mappings between fields in Relativity and Invariant. This functionality supports the processing feature available in Relativity. For more information, see Processing on the RelativityOne  Documentation site.
  - Headings: H1: Field Mapping Manager (.NET) | H2: Field mapping fundamentals | H3: Common field mapping workflow | H3: Code samples for the Field Mapping service | H2: Check field mapping availability | H2: Retrieve mapped Relativity fields | H2: Retrieve the contents of the Catalog Field table | H2: Retrieve Invariant fields available for mapping | H2: Retrieve Invariant fields available for mapping (paginated) | H2: Retrieve metadata fields | H2: Retrieve non-metadata fields | H2: Retrieve field given source name | H2: Retrieve an external field mapping | H2: Update an external field mapping | H2: Retrieve GUIDs for automapped fields

- [Field Mapping Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Field_Mapping_service.htm): Use the Field Mapping Manager REST service to retrieve mappable fields and read or update field mappings between Relativity and Invariant, with a client code sample.
  - Second paragraph: Currently, this service supports only managing the mappings between fields in Relativity and Invariant. This functionality supports the processing feature available in Relativity. For more information, see Processing on the RelativityOne  Documentation site.
  - Headings: H1: Field Mapping Manager (REST) | H2: Client code sample | H2: Check field mapping availability | H2: Retrieve mapped Relativity fields | H2: Retrieve Invariant fields available for mapping | H2: Retrieve an external field mapping | H2: Update an external field mapping | H2: Retrieve GUIDs for automapped fields | H2: Get Invariant fields available for mapping with pagination | H2: Retrieve metadata fields | H2: Retrieve non-metadata fields | H2: Retrieve field given source name | H2: Retrieve the contents of the Catalog Field table

- [Get started with the Processing API] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Get_started_with_the_Processing_API.htm): Get started with the Processing API to automate processing workflows, including creating custodians, data sources, and processing sets and running inventory, discovery, and publishing jobs.
  - Second paragraph: In v12.2.19 the Processing Profile Manager API endpoint was removed, consumers should now use Object Manager API.
  - Headings: H1: Get started with the Processing API | H2: Processing API fundamentals | H3: Common processing workflows | H2: Processing API prerequisites | H2: Development guidelines for the Processing API

- [Processing .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_NET_API_Reference.htm): Browse the Processing .NET API reference for the Relativity.Processing.SDK, including its interfaces and classes.
  - Headings: H1: Processing .NET API Reference | H2: Relativity.Processing.SDK

- [Processing .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/ProcessingNETAPI.html): Processing .NET API Reference

- [Processing API] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing.htm): Find the Processing landing page, with links to the .NET and REST processing manager topics, getting started and troubleshooting content, earlier versions, and version history.
  - Headings: H1: Processing | H2: Current Processing API content | H2: Previous versions of content | H2: Version History

- [Processing API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_API_Reference.htm): Find the Processing API reference page, which has moved to the Processing landing page.
  - Headings: H1: Processing API Reference

- [Processing API services for REST] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_API_services_for_REST.htm): Use the Processing REST services to automate processing workflows, including the custodian, data source, document, filter, job, set, and field mapping managers.
  - Second paragraph: Similar to the .NET interfaces on the Processing API, you can use the following services supported through REST to automate your processing workflows:
  - Headings: H1: Processing API services for REST

- [Processing Custodian Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Custodian_Manager.htm): Use the IProcessingCustodianManager .NET interface to create, read, and update processing custodians, with code samples.
  - Second paragraph: Read the values for the properties on a ProcessingCustodian object by calling the ReadAsync() method on the proxy created with IProcessingCustodianManager interface. The ReadAsync() method requires that you pass the Artifact IDs of the ProcessingCustodian object and the workspace as arguments.
  - Headings: H1: Processing Custodian Manager (.NET) | H2: Create a processing custodian | H2: Read a processing custodian | H2: Update a processing custodian

- [Processing Custodian Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Custodian_Manager_REST.htm): Use the Processing Custodian Manager REST endpoint to create, read, and update custodians, with request body examples for individual and other entity types.
  - Second paragraph: To create a processing custodian, send a POST request to the following URL
  - Headings: H1: Processing Custodian Manager (REST) | H2: Create a processing custodian | H2: Read a processing custodian | H2: Update a processing custodian

- [Processing Data Source Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Data_Source_Manager.htm): Use the IProcessingDataSourceManager .NET interface to create, read, and update processing data sources, with parameters and code samples.
  - Second paragraph: <string>DocumentNumberPrefix : prefix to be used for the documents in the processing data source
  - Headings: H1: Processing Data Source Manager (.NET) | H2: Create a processing data source | H2: Read a processing data source | H2: Update a processing data source | H2: Validate a processing data source for deletion | H2: Retrieve processing source location paths

- [Processing Data Source Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Data_Source_Manager_REST.htm): Use the Processing Data Source Manager REST endpoint to create, read, and update data sources that specify the location of files for discovery, with request examples.
  - Second paragraph: To create a processing data source, send a POST request to the following URL
  - Headings: H1: Processing Data Source Manager (REST) | H2: Create a processing data source | H2: Read a processing data source | H2: Update a processing data source | H2: Validate a processing data source for deletion | H2: Retrieve processing source location paths

- [Processing Document Manager (.NET) v2] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Document_Manager.htm): Use the IProcessingDocumentManager .NET interface (v2) to retrieve document metadata and error history for documents in a publishing set, with code samples.
  - Second paragraph: <long>: representing the number of publishable documents
  - Headings: H1: Processing Document Manager (.NET) v2 | H2: Retrieve metadata fields and values for a document | H2: Retrieve error history for a document | H2: Retry deleting documents | H2: Retry document errors | H2: Publish documents | H2: Retrieve publish job errors | H2: Retrieve count of publishable documents

- [Processing Document Manager (REST) v2] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Document_Manager_REST.htm): Use the Processing Document Manager REST endpoints (v2) to retrieve document metadata, file paths, and error history for documents in a publishing set.
  - Second paragraph: See the section on Filter expressions for more details on building an Expression value, which may be used in  the Request Body for certain endpoints.
  - Headings: H1: Processing Document Manager (REST) v2 | H2: Retrieve metadata fields and values for a document | H2: Retrieve metadata fields and values for multiple documents | H2: Retrieve the physical file locations for the requested documents | H2: Retrieve error history for a document | H2: Retry deleting documents | H2: Retry document errors | H2: Publish documents | H2: Retrieve publish job errors | H2: Retrieve count of publishable documents

- [Processing Filter Manager (.NET) v2] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Filter_Manager_API.htm): Use the Processing Filter Manager .NET API (v2) to create, update, delete, and apply filters that select processed documents before publishing.
  - Second paragraph: As a sample use case, you may want to implement a simplified processing workflow by programmatically adding complex criteria to filters applied to processing jobs in Relativity. This approach eliminates the need to manually enter filter criteria through the UI, which may be time consuming and error prone. Similarly, you can also use the Processing Filter Manager service to modify the settings on these or other complex filters implemented in your environment.
  - Headings: H1: Processing Filter Manager (.NET) v2 | H2: Fundamentals for the Processing Filter Manager API | H3: Methods | H3: Classes and enumerations | H2: Guidelines for the Processing Filter Manager API | H3: Access rights | H3: Helper methods | H3: Filter expressions | H2: Apply a processing filter | H2: Retrieve discovered documents | H2: Retrieve discovered document IDs | H2: Pivot on discovered documents | H2: Download a csv listing of discovered files

- [Processing Filter Manager (REST) v2] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Filter_Manager_service_in_REST.htm): Use the Processing Filter Manager REST service (v2) to create, update, delete, and apply filters that select processed documents before publishing.
  - Second paragraph: As a sample use case, you may want to implement a simplified processing workflow by programmatically adding complex criteria to filters applied to processing jobs in Relativity. This approach eliminates the need to manually enter filter criteria through the UI, which may be time consuming and error prone. Similarly, you can also use the Processing Filter Manager service to modify the settings on these or other complex filters implemented in your environment.
  - Headings: H1: Processing Filter Manager (REST) v2 | H2: Client code sample | H2: Guidelines for the Processing Filter Manager service | H3: Access rights | H3: Filter expressions | H2: Apply a processing filter | H2: Retrieve discovered documents | H2: Retrieve filtered data | H2: Pivot on discovered documents | H2: Get discovered documents IDs | H2: Download discovered documents list | H2: Download NISTed documents list for a processing set

- [Processing Job Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Job_Manager.htm): Use the IProcessingJobManager .NET interface to submit inventory, discovery, and publishing jobs and cancel them for a processing set, with code samples.
  - Second paragraph: The following code illustrates how to run an inventory job by calling the SubmitInventoryJobsAsync() method on the proxy created with the IProcessingJobManager interface.
  - Headings: H1: Processing Job Manager (.NET) | H2: Inventory jobs | H2: Discovery jobs | H2: Publishing jobs | H2: Retry Publishing jobs | H2: Cancel jobs

- [Processing Job Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Job_Manager_REST.htm): Use the Processing Job Manager REST endpoint to run inventory, discovery, and publishing jobs and cancel them for a processing set, with a client code sample.
  - Second paragraph: You can use the following .NET code as a sample client for submitting a discovery job.
  - Headings: H1: Processing Job Manager (REST) | H2: Client code sample | H2: Submit a discovery job | H2: Submit a inventory job | H2: Submit a publish job | H2: Retry errors job | H2: Cancel job

- [Processing REST API Reference (v1)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_REST_API_Reference.htm): Browse the Processing REST API reference (v1) for the relativity-processing service and its endpoints.
  - Headings: H1: Processing REST API Reference (v1) | H2: relativity-processing

- [Processing REST API Reference (v2)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_REST_API_V2_Reference.htm): Browse the Processing REST API reference (v2) for the relativity-processing service and its endpoints.
  - Headings: H1: Processing REST API Reference (v2) | H2: relativity-processing

- [Processing REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/ProcessingRESTAPIv2.html): Processing REST API Reference (v2)

- [Processing REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/ProcessingRESTAPI.html): Processing REST API Reference (v1)

- [Processing Set Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Set_Manager.htm): Use the IProcessingSetManager .NET interface to create, read, and update processing sets that link a processing profile to data sources, with code samples.
  - Second paragraph: Read the values for the properties on a ProcessingSet object by calling the ReadAsync() method on the IProcessingSetManager. The ReadAsync() method requires that you pass the Artifact IDs of the ProcessingSet object and the workspace as arguments.
  - Headings: H1: Processing Set Manager (.NET) | H2: Create a processing set | H2: Read a processing set | H2: Update a processing set | H2: Retrieve a list of  processing sets and related aggregate information | H2: Retrieve processing set summary data

- [Processing Set Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Set_Manager_REST.htm): Use the Processing Set Manager REST endpoint to create, read, and update processing sets that link a profile to data sources, with request examples.
  - Second paragraph: To create a processing set, send a POST request to the following URL
  - Headings: H1: Processing Set Manager (REST) | H2: Create a processing set | H2: Read a processing set | H2: Update a processing set | H2: Retrieve document aggregates | H2: Retrieve processing set summary data

- [Troubleshooting Processing API errors] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Troubleshooting_Processing_API_errors.htm): Troubleshoot errors returned by custom processing workflows, such as IProcessingJobManager call errors, by reviewing each error message, description, and resolution.
  - Second paragraph: If no data sources have been created for a processing set, then there is no job to cancel.
  - Headings: H1: Troubleshooting Processing API errors | H2: IProcessingJobManager method call errors | H2: IProcessingSetManager method call errors | H2: IProcessingDataSourceManager method call errors


### Production
- [Production .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_NET_API_Reference.htm): Browse the Production .NET API reference for the Relativity.Productions.SDK, including its interfaces and classes.
  - Headings: H1: Production .NET API Reference | H2: Relativity.Productions.SDK

- [Production .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/ProductionNETAPI.html): Production .NET API Reference

- [Production Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production.htm): Find the Production landing page for integrating Relativity productions with other tools, with the changelog of the versioned Production API and links to related content.
  - Second paragraph: This page aims to collect and centralize any useful information on the Production business domain.
  - Headings: H1: Production | H2: Current Production API content | H2: Version History

- [Production Data Source Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Data_Source_Manager_API.htm): You can use the Services API to create, delete, read, and update data sources that can then be added to productions.
  - Second paragraph: The Production Data Source Manager API supports the following functionality:
  - Headings: H1: Production Data Source Manager (.NET) | H2: Fundamentals for the Production Data Source Manager API | H2: Create a data source | H2: Read a data source | H2: Update a data source | H2: Delete a data source | H2: Retrieve default field values for a data source

- [Production Data Source Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Data_Source_Manager_service.htm): The Relativity REST API supports operations on production data source though the Production Data Source Manager service. You can use the service to create, delete, read, and update data sources.
  - Second paragraph: The Production Data Source Manager service supports the following functionality:
  - Headings: H1: Production Data Source Manager (REST) | H2: Guidelines for productions in REST | H3: URLs | H2: Create a data source | H2: Retrieve a data source | H2: Update a data source | H2: Delete a data source | H2: Retrieve default field values for a data source

- [Production Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Manager_API.htm): The Productions API manages productions in a workspace.
  - Second paragraph: The Production Manager API exposes methods that provide the following functionality for productions:
  - Headings: H1: Production Manager (.NET) | H2: Fundamentals for the Production Manager API | H2: Production sets and jobs | H3: Create a production set | H3: Retrieve a production set | H3: Delete a production set | H3: Stage a production | H3: Run a production job | H3: Stage and run multiple productions | H3: Re-run a production | H3: Run a Post Production Job | H2: Default fields and restrictions for productions | H3: Retrieve default field values for a production | H3: Set production restrictions on a workspace | H3: Retrieve the ID of a save search used for production restrictions | H2: Production job status, progress, and other information | H3: Retrieve the job status of a production | H3: Retrieve progress details for a production | H3: Retrieve production status details | H3: Retrieve results for produced image files | H3: Retrieve all productions in a workspace | H3: Retrieve produced productions for documents | H3: Retrieve a token for paging through images | H2: Production errors and document conflicts | H3: Retrieve conflicts, errors, and other production information | H3: Retrieve staging errors for a production | H3: Retrieve branding errors for a production | H3: Retrieve documents conflicting with production restrictions | H3: Remove documents conflicting with production restrictions | H2: Re-production jobs | H3: Retrieve productions eligible for re-production | H3: Retrieve re-productions for a specific production | H3: Stage and run a re-production job | H3: Cancel jobs for a re-production

- [Production Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Manager_service.htm): Through the REST API, the Productions API manages productions in a workspace.
  - Second paragraph: The Production Manager API exposes endpoints that provide the following functionality for productions:
  - Headings: H1: Production Manager (REST) | H2: Guidelines for productions in REST | H3: URLs | H2: Postman sample file | H2: Production sets and jobs | H3: Create a production set | H3: Retrieve a production set | H3: Delete a production set | H3: Stage a production | H3: Run a production job | H3: Stage and run multiple production jobs | H3: Re-run a production | H3: Run a Post Production Job | H2: Default fields and restrictions for productions | H3: Retrieve default field values for a production | H3: Set production restrictions on a workspace | H3: Retrieve the ID of a save search used for production restrictions | H2: Production job status, progress, and other information | H3: Retrieve the job status of a production | H3: Retrieve progress details for a production | H3: Retrieve production status details | H3: Retrieve results for produced image files | H3: Retrieve all productions in a workspace | H3: Retrieve produced productions for documents | H3: Retrieve a token for paging through images | H2: Production errors and document conflicts | H3: Retrieve conflicts, errors, and other production information | H3: Retrieve staging errors for a production | H3: Retrieve branding errors for a production | H3: Retrieve documents conflicting with production restrictions | H3: Remove documents conflicting with production restrictions | H2: Re-production jobs | H3: Retrieve productions eligible for re-production | H3: Retrieve re-productions for a specific production | H3: Stage and run a re-production job | H3: Cancel jobs for a re-production

- [Production Placeholder Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Placeholder_Manager_API.htm): You can use the Services API to create, delete, read, and update placeholders that can then be added to productions. When you create a production placeholder, you can either upload image data for the placeholder as the FileData property, or use HTML-formatted text as the CustomText property.
  - Second paragraph: The Production Placeholder Manager API supports the following functionality:
  - Headings: H1: Production Placeholder Manager (.NET) | H2: Fundamentals for the Production Placeholder Manager API | H2: Create a placeholder | H2: Read a placeholder | H2: Update a placeholder | H2: Delete a placeholder | H2: Retrieve default field values for a placeholder

- [Production Placeholder Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Placeholder_Manager_service.htm): Use the Production Placeholder Manager REST service to create, read, update, and delete placeholders and retrieve their default field values.
  - Second paragraph: The Production Placeholder Manager API supports the following functionality:
  - Headings: H1: Production Placeholder Manager (REST) | H2: Guidelines for productions in REST | H3: URLs | H2: Create a placeholder | H2: Retrieve a placeholder | H2: Update a placeholder | H2: Delete a placeholder | H2: Retrieve default field values for a placeholder

- [Production Queue Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Queue_Manager_API.htm): Use the Production Queue Manager .NET API to get production jobs in the queue, cancel or retry jobs, and set job priority.
  - Second paragraph: The Production Queue Manager API exposes methods used to cancel a single or multiple production jobs, to retry multiple jobs, or to set the priority for them. You can identify the jobs for canceling or retrying by mass operation token or Artifact ID.
  - Headings: H1: Production Queue Manager (.NET) | H2: Fundamentals for the Production Queue Manager API | H2: Get all production jobs in queue | H2: Cancel a production job | H2: Cancel production jobs by mass operation token | H2: Cancel production jobs by ID | H2: Set the priority on production jobs

- [Production Queue Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Queue_Manager_service.htm): Use the Production Queue Manager REST service to get production jobs in the queue, cancel or retry jobs, and set job priority.
  - Second paragraph: The Production Queue Manager service exposes endpoints used to cancel a single or multiple production jobs, to retry multiple jobs, or to set the priority for them. You can identify the jobs for canceling or retrying by mass operation token or Artifact ID.
  - Headings: H1: Production Queue Manager (REST) | H2: Guidelines for productions in REST | H3: URLs | H2: Get all production jobs in queue | H2: Cancel a production job | H2: Cancel production jobs by mass operation token | H2: Cancel production jobs by ID | H2: Set the priority on production jobs | H2: Retry production jobs by mass operation token | H2: Retry production jobs by ID

- [Production REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_REST_API_Reference.htm): Browse the Production REST API reference for the relativity-productions service and its endpoints.
  - Headings: H1: Production REST API Reference | H2: relativity-productions

- [Productions REST Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/ProductionRESTAPI.html): Production Service REST Reference

- [Re-production Job Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Reproduction_Job_Manager_API.htm): Use the Re-production Job Manager .NET API to create re-production jobs and retrieve their IDs and statuses for documents from a completed production.
  - Second paragraph: The Re-production Job Manager API supports the following functionality:
  - Headings: H1: Re-production Job Manager (.NET) | H2: Fundamentals for the Re-production Manager API | H2: Create a re-production job | H2: Retrieve re-production job IDs | H2: Retrieve the status for a re-production job

- [Re-production Job Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Production/Reproduction_Job_Manager_Service.htm): Use the Re-production Job Manager REST service to create re-production jobs and retrieve their IDs and statuses for documents from a completed production.
  - Second paragraph: The Re-production Job Manager service provides the following functionality:
  - Headings: H1: Re-production Job Manager (REST) | H2: Guidelines for productions in REST | H3: URLs | H2: Create a re-production job | H3: Use document IDs to create a job | H3: Use a mass operation token to create a job | H2: Retrieve re-production job IDs | H2: Retrieve the status for a re-production job


### Publish to Relativity Tool
- [Publish to Relativity tool] (https://platform.relativity.com/RelativityaiR/Content/Publish_to_Relativity_Tool/Publish_to_Relativity_tool.htm): The Publish to Relativity tool simplifies application development by storing reusable configuration that you can use to upload custom pages and resource files to Relativity. It eliminates the need to export and reimport applications in order to deploy modifications to your applications. Instead, you can define application and connection settings, which are stored in the app.config file. The tool automatically uses this configuration to upload new or updated files to a Relativity application. You can use the Publish to Relativity tool to perform the following tasks.
  - Headings: H1: Publish to Relativity tool


### RDO
- [Building Media Tracker with Relativity  Dynamic Objects] (https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Building_Media_Tracker_with_RDOs.htm): Media Tracker is an application you can build using Relativity  Dynamic Objects (RDOs). With Media Tracker, you can track media received from vendors, clients, and opposing counsel. After you build and deploy the application in a workspace, you can manually input the media and related metadata.
  - Second paragraph: Complete the following steps to create a Media Tracker application and then import it into Relativity  workspaces.
  - Headings: H1: Building Media Tracker with Relativity  Dynamic Objects | H2: Create a new application | H2: Link and create object types | H2: Update and create fields | H2: Update views | H2: Build layouts | H2: Export Media Tracker application

- [Creating a question object] (https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Creating_a_question_object.htm): Custodians can have multiple documents linked to them, but documents can have only one custodian. This is a one-to-many relationship – many documents to one custodian.
  - Second paragraph: A reviewer may have one or many questions about a document, and each question may be associated with one or many documents. This is a many-to-many relationship: many documents to many questions.
  - Headings: H1: Creating a question object | H2: Creating the Question object type | H2: Editing field and layout views | H3: Editing the Fields view | H3: Editing the Layouts view | H3: Filtering to view Question types | H2: Creating the Question object fields | H3: Creating the Question field | H3: Creating the Answer field | H3: Creating a multiple object field | H2: Writing questions and modifying the Question tab | H3: Adding new questions | H3: Adding an Answer to the Question detail page | H3: Adding the Documents list to the Question detail page | H3: Adding Answers to the Question tab | H2: Adding questions to a layout in the viewer | H2: Setting up Question-related views | H3: Creating a Document view for documents with questions | H3: Creating a Document view for documents with no questions | H2: Linking questions to a document during review

- [Creating a tab to bookmark an object] (https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Creating_a_tab_to_bookmark_an_object.htm): You can create new a tab that links you directly to any web page or a location within Relativity. This is useful for bypassing list views or for going to specific locations. In both cases, it potentially saves navigation steps.
  - Second paragraph: If the target is a Relativity page or object, you need the ArtifactID.
  - Headings: H1: Creating a tab to bookmark an object | H2: Finding the ArtifactID | H2: Creating the tab

- [Creating and editing Relativity Objects] (https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Creating_and_editing_Relativity_Objects.htm): RDOs are object types that you create and manage from within any Relativity application. They help process and organize data. For example, you can assign information to them and create new data structures. You can also attach external applications such as event handlers and rules to extend their functionality.
  - Second paragraph: To create an object from a workspace:
  - Headings: H1: Creating and editing Relativity Objects | H2: Permissions | H2: Creating an object from a workspace | H2: Creating an object from home | H2: Deleting an object from a workspace | H2: Deleting an object from home | H2: Editing an object's details | H2: Fields for an object type | H3: Object Type Information section | H3: Object Type Settings section | H3: Other section | H2: Adding an event handler | H3: Deleting an event handler | H2: Adding an object rule | H3: Default Layout | H3: Custom Single Object Add Link Visibility | H3: Default Layout on New | H3: Global Button Visibility | H3: Mass Action Visibility | H3: Choice Behavior | H3: Sub-List Button Visibility | H3: New Button Override | H3: Override edit link URL | H3: Override view link URL | H2: Adding a custom mass operation | H3: Mass operation fields | H2: Adding information to objects

- [Deleting object dependencies] (https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Deleting_object_dependencies.htm): Deleting object dependencies removes that object
  - Second paragraph: You also need to have the correct level of permissions. See your system admin for additional details. With the Delete Object Dependencies  permission, you can force delete the current object, which includes deleting its children and unlinking associative objects.
  - Headings: H1: Deleting object dependencies | H2: Force deleting object dependencies | H2: Displaying and interpreting the dependencies report | H2: Considering the fields of force deleted objects | H3: Analytics categorization set example | H3: Search terms reports example

- [Relativity Objects] (https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Relativity_objects.htm): Relativity contains two kinds of objects. System objects, and Relativity Dynamic Objects (RDOs), also called dynamic objects. Both kinds, collectively called objects, are the building blocks Relativity applications. Objects connect together, whether implicitly resulting from a workflow, or explicitly by you defining the connections. Through these connections or links, you extend functionality by storing data and making efficient use of its organization. You can attach many kinds of objects to additional features or functionality, such as object rules and event handlers. This allows Relativity, third party, or in-house developers to introduce custom features specific to your needs.
  - Second paragraph: As an example of using objects to extend data reach, from within a workspace, you can create your own RDO for storing custodian information, including not only custodian names but also their emails, sent and received dates, and recipients. This information can then link to other documents or for greater granularity in sorting, searching, or listing those documents.
  - Headings: H1: Relativity Objects | H2: System objects | H2: Relativity  Dynamic Objects (RDOs) | H2: Programmatically using Relativity objects and RDOs


### Relativity API Helpers
- [Advanced code sample for database interactions] (https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Advanced_code_sample_for_database_interactions.htm): You with can use the IDBContext interface in the Relativity Helpers API to run queries, manage database transactions and perform various types of common database operations from agents, custom pages, and event handlers. You must add a reference to the Relativity.API.dll to your Visual Studio project to use this the IDBContext interface. See Setting up your development environment.
  - Second paragraph: You can use the advanced functionality available through this interface. The JobQueries class demonstrates how to query for data, modify it, and then modify database transactions. For a basic code sample, see Basic concepts for Relativity API Helpers.
  - Headings: H1: Code sample for database interactions

- [Basic concepts for Relativity API Helpers] (https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Basic_concepts_for_Relativity_API_Helpers.htm): Review these basic concepts to learn more about how the Relativity API Helpers can simplify your development tasks with interfaces used for creating the proxy, obtaining database contexts, and performing other tasks through custom pages, event handlers, and agents.
  - Second paragraph: Add a reference to the Relativity.API.dll available in the SDK installer to Visual Studio before attempting to write code against the API Helper interfaces. The Relativity API Helpers provides several interfaces that you can use with agents, custom pages, and event handlers. The interfaces for use with each of these Relativity components contain similar methods. Consequently, you can write common code for connecting to databases and the Relativity Services API, or performing other tasks.
  - Headings: H1: Basic concepts for Relativity API Helpers | H2: Reference the Relativity.API.dll in your projects | H2: Connect to the Services API | H2: Obtain a database context | H2: Obtain user context information | H2: Obtain workspace ID | H2: Obtain the artifact GUID | H2: Work with the Secret Store | H3: ISecretStore interface | H3: Secret class | H3: Secret path | H3: Secret store example | H2: Work with instance settings | H3: InstanceSettingsBundle interface | H3: Instance settings example | H2: Build friendly URLs for custom pages | H2: Use Relativity API Helpers for unit testing

- [Query SMTP settings when sending email] (https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Querying_SMTP_settings_when_sending_email.htm): This example demonstrates how to use IDBContext interface to query the Relativity database for SMTP server settings when sending email notifications from agents, custom pages, or event handlers using the standard .NET mail interface.
  - Second paragraph: This code sample uses the IInstanceSettingsBundle interface available in Relativity aiR 9.6.110.36 and above.
  - Headings: H1: Query SMTP settings when sending email

- [Relativity API Extensions] (https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Relativity_API_Extensions.htm): Use the Relativity.API.Extensions helper functions GetInstanceBaseURL and BuildHTTPAuthorizationHeader to set up REST service calls to a specific environment. Includes a usage example.
  - Second paragraph: While this is a new API focused more on interacting with Relativity aiR through REST services, you can also continue to use the ServiceFactory, which provides the same benefits for consumers of Relativity aiR .NET API client libraries.
  - Headings: H1: Relativity.API.Extensions | H2: Usage Examples | H2: FAQs | H2: Version History

- [Relativity API Extensions .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/RelativityAPIExtensionsNETAPI.html): Relativity API Extensions .NET API Reference

- [Relativity API Extensions .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Relativity_API_Extensions_NET_API_Reference.htm): Reference landing page for the Relativity.Api.Extensions .NET API, which provides helper functions for building service URLs and authorization headers.
  - Headings: H1: Relativity API Extensions .NET API Reference | H2: Relativity.Api.Extensions

- [Relativity API Helpers] (https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Using_Relativity_API_Helpers.htm): The Relativity API Helpers include standard interfaces that you can program against when developing agents, custom pages, and event handlers. They provide you with the ability to write common code that can be shared across these extensibility points, which simplifies your development processes and facilitates code reusability. You can use the Relativity API Helpers to perform these tasks in your custom code.
  - Second paragraph: You can also review the code samples for agents, custom pages, and event handlers, which use the API Helper classes for establishing database connections.
  - Headings: H1: Relativity API Helpers

- [Relativity API Helpers .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Relativity_API_NET_API_Reference.htm): Reference landing page for the Relativity API Helpers .NET API (Relativity.Api), which provides interfaces for agents, custom pages, and event handlers.
  - Headings: H1: Relativity API Helpers .NET API Reference | H2: Relativity.Api

- [Relativity API Helpers .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/RelativityAPINETAPI.html): Relativity API Helpers .NET API Reference

- [Relativity.API] (https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/RelativityAPI.htm): Learn about the Relativity.API package, which provides interfaces and data objects for Relativity extensibility points. Includes version history, release notes, and supported Relativity version ranges.
  - Headings: H1: Relativity.API | H2: Current Relativity.API content | H2: Version History


### Relativity Export SDK
- [Relativity Export SDK API Reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/RelativityExportSDKRESTAPI.html): Relativity Export SDK API Reference

- [Relativity Export SDK Reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Relativity_Export_SDK_Reference.htm): Reference landing page for the Relativity Export SDK .NET API.
  - Headings: H1: Relativity Export SDK API Reference

- [Relativity Export Service REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/RelativityExportService_REST_API_Reference.htm): Reference landing page for the Relativity Export Service REST API.
  - Headings: H1: Relativity Export Service REST API Reference | H2: Relativity.Export

- [Relativity Import Service API REST Reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/RelativityExportService_API.html): Relativity Import Service API REST Reference


### Relativity Forms
- [Add a custom item list to a layout] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Add_a_custom_item_list_to_a_layout.htm): Learn how to add a custom item list, such as audit history, to a Relativity Forms layout by using the transformLayout event handler, View information, and a custom data source built on the Audit API.
  - Second paragraph: There are three main things you will need to do in Relativity Forms to make this work:
  - Headings: H1: Add a custom item list to a layout | H2: Adding a new item list & view information | H3: Overriding default action bar buttons | H3: Calling an API to get Item list data | H3: Modifying the view to add field type information | H3: Turning on sorting | H3: Enable filtering | H3: Add custom action buttons | H3: Custom views | H3: Refreshing the item list

- [Additional Forms API objects] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Additional_Forms_API_objects.htm): Look up the additional Relativity Forms API objects and functions, including pop-up window objects, the eventNames object, and item list classes and enumerations such as ColumnDefinition and QueryRequest.
  - Second paragraph: The following table lists additional Forms API objects and functions.
  - Headings: H1: Additional Forms API objects | H2: Summary of additional Forms API objects and functions | H2: Filter | H3: eventNames object | H3: popupControlApi object | H3: Popup eventHandlerFactory function | H3: ColumnDefinition class | H3: ItemListColumn Properties | H3: CellContent class | H3: CellContentAlignment enumeration | H3: HeaderContent class | H3: IColumnIndicator interface | H3: FieldMetadata class | H3: Field Type ID enumeration | H3: Field Value | H3: Filter Types enumeration | H3: QueryRequest class | H3: Filter class | H3: Condition class | H3: Sort class | H3: QueryResponse class | H3: itemListDataProvider object | H3: itemListSettingPersistenceService object | H3: ItemListMetadata object | H3: Item List State class | H3: Item List Types enumeration | H3: Date Formats | H3: Relativity object | H3: ReadData object | H3: ExitDialog class | H3: RuntimeConfig class

- [Communicate between Relativity Form pages] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Communicate_between_Relativity_Form_pages.htm): Learn how to use relativityFormsPopup to add event handlers to a pop-up window so a parent Relativity Forms page is notified of events in the pop-up, and the guidelines that differ from standard handlers.
  - Second paragraph: For example, when clicking the Add link on a single object field and creating an object, you might expect that the newly created object appears as the value in the parent form, and the pop-up window is closed.
  - Headings: H1: Communicate between Relativity Form pages | H2: Guidelines for adding event handlers to a pop-up window | H2: Write code to add event handlers to a pop-up window | H3: Example

- [Debug Relativity Forms Event Handlers] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Debug_Relativity_Forms_event_handlers.htm): Use the RelativityFormsDebugObject in session storage to stop redirection to the error page and enable debug logging when you debug Relativity Forms event handlers, and learn how to add breakpoints.
  - Second paragraph: Holds properties that makes it easier for developers to debug errors that occur in form event handlers.
  - Headings: H1: Debug Relativity Forms Event Handlers | H2: RelativityFormsDebugObject | H2: Adding Breakpoints To Event Handler Code

- [Examples] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Common_workflows.htm): Find Relativity Forms API examples for common requirements, including converting a classic form and adding a custom item list to a layout, plus a GitHub repository of sample event handlers.
  - Second paragraph: In addition to these examples, see the repository at https://github.com/relativitydev/relativity-forms-development-tools/tree/main/examples for a Visual Studio solution containing example Relativity Forms Event Handlers. Note that the event handlers samples in this project are meant to serve as samples and not all of them may work out of the box; some may require setup. We recommend you use the project as a template and/or reference.
  - Headings: H1: Examples

- [Forms API Pipelines] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Forms_API_Pipelines.htm): Section landing page for the Relativity Forms API pipeline topics, such as the Load, Change, and Submit pipelines.
  - Headings: H1: Forms API Pipelines

- [Forms API Reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Forms_API_Reference.htm): Section landing page for the Relativity Forms API reference content.
  - Headings: H1: Forms API Reference

- [Implementing Relativity Forms event handlers] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Implementing_Relativity_Forms_event_handlers.htm): Learn how to implement Relativity Forms page interaction event handlers in JavaScript files and reference them from the .NET PageInteractionEventHandler class using ScriptFileNames.
  - Second paragraph: Use these guidelines when developing page interaction event handlers in Relativity Forms:
  - Headings: H1: Implementing Relativity Forms event handlers | H2: Guidelines for page interaction event handlers | H2: Customizing Relativity Forms pages with the Relativity Forms API | H3: Identifying the URL for a file | H2: Updating custom event handler script files | H2: Considerations

- [Migrating applications to Relativity Forms] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Migrating_To_Relativity_Forms.htm): Review which Classic Forms customizations, such as console or PageInteraction event handlers and PreLoad defaults, need updates when you migrate your applications to Relativity Forms.
  - Second paragraph: If you have customized user interfaces with Classic Forms, you will most likely need to update these customizations to use the new Relativity Forms approach.
  - Headings: H1: Migrating applications to Relativity Forms | H2: Determining if your applications are affected | H2: Classic Forms Deprecation Compliance Identification Tool | H2: Conceptual Differences | H2: Considerations | H2: Frequently Asked Questions

- [Relativity Forms API] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Relativity_Forms_API.htm): Learn what Relativity Forms is, how its front-end page life cycle and JavaScript APIs support customization of view, edit, and new layout pages, and how it affects classic form customizations.
  - Second paragraph: If you have customized Classic Forms pages, be aware that Relativity Forms may introduce breaking changes to your classic forms customizations. See the Migrating applications to Relativity Forms topic for more information on migrating to Relativity Forms. .
  - Headings: H1: Relativity Forms API | H2: What is Relativity Forms? | H2: Concepts

- [Relativity Forms API Reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Relativity_Forms_API_Reference.htm): Section landing page for the Relativity Forms API reference content.
  - Headings: H1: Relativity Forms API Reference

- [Sample: Converting a Classic Form to a Relativity Form] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Convert_to_Relativity_Forms.htm): Follow a sample that migrates a classic form with a console event handler and a page interaction event handler to a Relativity Form, from setting up the classic form through conversion.
  - Second paragraph: Complete the following steps to set up the classic form event handlers:
  - Headings: H1: Sample: Converting a Classic Form to a Relativity Form | H2: Setting up the classic form | H2: Migrating to Relativity Forms | H3: Converting the console event handler | H3: Converting the page interaction event handler | H3: Updating Relativity assets


### Relativity Import Service API
- [Import Service .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Import_NET_API_Reference.htm): Reference for the Relativity.Import.SDK .NET API used with the Relativity Import Service API.
  - Headings: H1: Import Service .NET API Reference | H2: Relativity.Import.SDK

- [Import Service .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/ImportNETAPI.html): Import Service .NET API Reference

- [Import Service Models .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Import_Models_NET_API_Reference.htm): Reference for the Relativity.Import.Models.SDK .NET API used with the Relativity Import Service API.
  - Headings: H1: Import Service Models .NET API Reference | H2: Relativity.Import.Models.SDK

- [Import Service Models .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/ImportModelsNETAPI.html): Import Service Models .NET API Reference

- [Relativity Import Service API REST Reference] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/RelativityImportService_API.html): Relativity Import Service API REST Reference

- [Relativity Import Service REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/RelativityImportServiceRESTAPI.html): Relativity Import Service REST API Reference

- [Relativity Import Service REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/RelativityImportService_REST_API_Reference.htm): REST API reference for the Relativity Import Service (Relativity.Import.Services).
  - Headings: H1: Relativity Import Service REST API Reference | H2: Relativity.Import.Services

- [Relativity Import Service REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Relativity_Import_Service_REST_API_Reference.htm): REST API reference for the Relativity Import Service (Relativity.Import.Services).
  - Headings: H1: Relativity Import Service REST API Reference | H2: Relativity.Import.Services


### Relativity Integration Points
- [Best Practices] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Best_practices_for_integration_point_development.htm): Follow these guidelines and checklist when you develop custom integration points, such as using separate projects for custom page and provider code and referencing the required Relativity libraries.
  - Second paragraph: Consider setting up your Visual Studio solution with separate projects for your custom page and provider code:
  - Headings: H1: Best practices for integration point development | H2: Use separate projects for custom page and provider code | H2: Reference the required Relativity libraries in your projects | H2: Create a custom application in Relativity | H2: Use GUIDs in your source code | H2: Subscribe to required JavaScript events | H2: Reference required JavaScript files in the view | H2: Include event handlers for your provider | H2: Display source provider settings selected by users | H3: Define a method for returning key-value pairs | H3: Set the ViewDataUrl property | H2: Use methods for batching in your provider code | H2: Upload .dll files to Relativity in the correct order | H2: Use unique identifiers and display names in your data | H2: Verify your IIS configuration | H2: Use secured configurations for sensitive information | H3: V1 endpoints for custom providers | H3: Migration to V2 endpoints for custom providers

- [Build an advanced integration point] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Build_an_advanced_integration_point.htm): Use the JSON Loader sample to learn how to build an integration point provider that ingests JSON data into RDOs, create a custom page, and use dependency injection in unit tests.
  - Second paragraph: You can view the source code for the JSON Loader application to learn how to develop custom integration points for different data formats. Download and extract the Relativity Integration Points SDK. Navigate to the \Integration Points SDK\Examples\JsonLoader folder. Open the JsonLoader.sln file in Visual Studio 2015.
  - Headings: H1: Build an advanced integration point | H2: View the source code | H2: Build the JSON Loader in Visual Studio

- [Build your first integration point] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Build_your_first_integration_point.htm): Follow this tutorial to build a simple integration point that ingests XML data into Relativity dynamic objects, including the custom page, the provider, and uploading your customizations.
  - Second paragraph: The process for developing an integration point follows many of the same steps used for developing other Relativity platform components. You learn how to set up a Visual Studio project where you add the source code for your custom page and provider. Additionally, the tutorial explains how to create your application, add the required libraries as references, and upload your customizations to Relativity for deployment.
  - Headings: H1: Build your first integration point | H2: Before you begin | H2: Create a Relativity application | H2: Set up your Visual Studio solution | H2: Define global constants | H2: Develop code for the client interface | H3: Add custom code to the controller | H3: Add a custom JavaScript file | H3: Add custom code to the view | H3: Add a custom CSS file | H2: Develop code for your provider | H3: Add a provider class | H3: Add a data reader class | H3: Add event handlers for registering and uninstalling your provider | H3: Compile your source code | H2: Deploy your integration point | H3: Upload required .dll files | H3: Publish your custom page project | H3: Upload your custom page | H3: Install your application | H2: Use your integration point in Relativity

- [Relativity Integration Points] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Get_started_with_integration_points.htm): Learn how the Relativity Integration Points framework lets you develop custom providers that import data, such as XML, JSON, or SQL, into RDOs, and find related development topics.
  - Second paragraph: See these related pages:
  - Headings: H1: Relativity Integration Points | H2: Understand the Relativity Integration Points framework | H2: Basic concepts for integration point development | H3: Workflow for importing data | H2: Relativity Integration Points API | H2: Integration Points SDK files

- [Troubleshoot and upgrade integration points] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Troubleshoot_integration_points.htm): Troubleshoot common integration point errors and learn how to upgrade custom integration points for Relativity 9.4 and above, including .dll references and the ProviderFactoryBase dependency injection changes.
  - Second paragraph: Use the following guidelines to upgrade your custom integration points for use in Relativity 9.4 and above.
  - Headings: H1: Troubleshoot and upgrade integration points | H2: Upgrade integration points for use in Relativity 9.4 and above | H3: Update the .dll references in your projects | H3: Update the use of dependency injection | H3: Recompile and upload your integration point | H3: Upload remaining assemblies to Relativity | H2: Troubleshoot integration points | H3: Integration point doesn't run | H3: Integration point exhibits poor performance | H2: Debug an integration point


### Relativity Platform
- [Data Import and Export APIs] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Data_Import_and_Export_APIs.htm): Compare the Relativity APIs for transferring data to and from Relativity, including the Import Service, Export Service, Transfer API, and Relativity Transfer SDK.
  - Headings: H1: Data Import and Export APIs

- [Documentation archives] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Documentation_archives.htm): If you need technical assistance, contact our Support team via the information on our Support page.
  - Second paragraph: The content on this website is for development in Relativity aiR. If you're using a different version of Relativity, you can refer to the documentation from the appropriate version:
  - Headings: H1: Documentation archives | H2: Proprietary Rights

- [Platform API rate limits] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Platform_API_Rate_Limits.htm): Learn the enforced rate limits on select Relativity APIs, such as the 0.5 GB per tenant rolling 24-hour limit on the Object Manager StreamLongText endpoint, and how the Retry-After header works.
  - Second paragraph: 0.5 GB / tenant / rolling 24 hours
  - Headings: H1: Platform API rate limits | H2: Exceeding the limit | H3: Rate limit response headers | H3: HTTP status codes | H2: Handling rate limit errors

- [Platform Extension APIs] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Platform_Extension_APIs.htm): Review the platform extension APIs that expose .NET interfaces for agents, custom pages, event handlers, Kepler services, and Relativity API Helpers hosted on the Relativity platform.
  - Headings: H1: Platform Extension APIs

- [Relativity aiR Platform APIs] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Platform_APIs.htm): Learn how the Relativity platform APIs let you programmatically perform tasks that users complete in the UI, such as creating workspaces and adding users, and find the integration and extension APIs.
  - Second paragraph: (REST-only API)
  - Headings: H1: Relativity aiR APIs | H2: Integration APIs | H2: Extension APIs

- [Relativity API error handling] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/API_error_handling.htm): Learn how Relativity APIs report errors, including HTTP status code classes in REST services, and how your application code should respond to them to build resilient applications.
  - Second paragraph: All APIs return errors, which may be generally categorized as follows:
  - Headings: H1: API error handling | H2: Errors in RESTful services | H3: Handling errors | H2: Error handling in .NET | H2: Error code changes over time | H2: Best practices for error handling

- [Relativity API reference] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_API_reference.htm): The Relativity API reference explains the classes, interfaces, value types, and other members that are included in the Relativity SDK. These members provide access to system functionality and serve as the foundation for building Relativity applications.
  - Second paragraph: The following table lists the platform Integration APIs, with links to supporting documentation. (For convenience, you can download OASFiles.zip, which contains the REST OpenAPI Specification (OAS) files.)
  - Headings: H1: Class library reference | H2: Integration APIs | H2: Extension APIs

- [Relativity developer documentation] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/index.htm): Developer documentation for RelativityOne and Relativity Server. Find what you need by level or search the site.
  - Second paragraph: Along with the renaming of RelativityOne to Relativity aiR, other product and feature names have also changed:
  - Headings: H1: Developer Documentation | H2: Browse content | H3: Explore | H3: Integrate | H3: Extend | H2: Additional Developer Resources

- [SDK and API Comparison: Relativity aiR vs Relativity Server] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/SDK_API_Comparison.htm): Lists and compares the available APIs in Relativity aiR and Relativity Server
  - Headings: H1: SDK and API comparison: Relativity aiR vs Relativity Server

- [Testing custom applications] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Testing_custom_applications.htm): Learn how to write testable code and automate testing of custom applications, including unit tests and mock objects, to shorten regression cycles and deploy with confidence.
  - Second paragraph: This page contains information about how you can implement testing for new and existing custom applications that shorten your regression cycles and efficiently deploy applications into production. It also discusses the importance of writing testable code that uses automation in this process.
  - Headings: H1: Testing custom applications | H2: Types of tests for custom applications | H3: Unit tests | H3: Integration tests | H3: Continuous integration testing | H2: Code coverage | H2: Testable code | H2: Steps for writing unit tests | H2: Testing Sandboxes  for Relativity aiR applications | H2: Automated tests in Relativity aiR Sandboxes | H2: Recommendations for application development | H2: Additional testing resources | H3: Relativity repository on GitHub | H3: Additional NUnit testing information | H3: Visual Studio templates

- [Tools and Resources] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Get_started.htm): Relativity Platform includes an extensive set of APIs, establishing a virtual parity between the functionality available through Relativity and the capabilities of custom applications that use the APIs.
  - Second paragraph: Whether you're an experienced Relativity partner, a third-party software developer, or you're new to Relativity development, there are several ways for you to engage with the community to get and give advice, exchange code, and share your feedback about APIs and features. Here are some options for obtaining developer support and interacting with our community:
  - Headings: H1: Tools and Resources | H2: SDKs, APIs, NuGet packages, and templates | H2: Developer Support

- [UI Customization APIs] (https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/UI_Customization_APIs.htm): Get an overview of the JavaScript UI customization APIs, including the Relativity Forms API, Lists Interaction APIs, Review API, and supported JavaScript APIs.
  - Headings: H1: UI Customization APIs


### Relativity services
- [Folder Manager  (.NET)] (https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Folder_Manager_API.htm): Use the .NET Folder Manager service and its IFolderManager interface to create, update, move, query, and delete folders, retrieve folder trees, and monitor folder deletion progress.
  - Second paragraph: You can also use the Folder Manager service to create, update, delete, and query for folders through the REST API. For more information, see Folders.
  - Headings: H1: Folder Manager  (.NET) | H2: Folder Manager service | H3: Accessing the Folder Manager service | H2: Create a folder | H2: Update a folder | H2: Delete unused folders | H2: Query for folders | H2: Helper methods | H3: Retrieve the root Folder for a workspace | H3: Retrieve subfolders | H3: Retrieve expanded Folder nodes | H3: Retrieve ancestors of a Folder | H3: Get access status for a Folder | H2: Move Folders

- [Logging .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Logging_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.Logging namespace.
  - Headings: H1: Logging .NET API Reference | H2: Relativity.Logging

- [Logging .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/LoggingNETAPI.html): Logging .NET API Reference

- [Logging Interfaces .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/LoggingInterfacesNETAPI.html): Logging Interfaces .NET API Reference

- [Logging Interfaces .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Logging_Interfaces_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.Logging.Interfaces namespace.
  - Headings: H1: Logging Interfaces .NET API Reference | H2: Relativity.Logging.Interfaces

- [RSAPI SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/RSAPINETAPI.html): RSAPI SDK .NET API Reference

- [RSAPI SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/RSAPI_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.Rsapi SDK. RSAPI is deprecated, but you may still need the SDKs in the RSAPI Package.
  - Headings: H1: RSAPI SDK .NET API Reference | H2: Relativity.Rsapi

- [Search Container Manager  (.NET)] (https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Search_Container_Manager_API.htm): Relativity saved searches can be organized using logical folders. The Services API supports the creating, reading, updating, deleting, and quering saved search folders through the SearchContainer DTO. A helper method to easily return the content of a SearchContainer - saved searches and subfolders - is also provided. You can perform the operations on SearchContainer DTOs asynchronously.
  - Second paragraph: The Services API supports creating, reading, updating, deleting, and querying saved search folders as SearchContainer DTOs. A helper method to easily return the content of a SearchContainer (saved searches and subfolders) is also provided. You can perform the operations on SearchContainer DTOs asynchronously.
  - Headings: H1: Search Container Manager  (.NET) | H2: Create a SearchContainer | H2: Read a SearchContainer | H2: Update a SearchContainer | H2: Delete a SearchContainer | H2: Query SearchContainers | H2: List SearchContainer content | H3: GetSearchContainerItemsAsync() | H3: GetChildSearchContainersAsync() | H2: Retrieve expanded search container nodes | H3: GetSearchContainerTreeAsync() | H3: GetFilteredSearchContainerTreeAsync() | H2: Retrieve Advanced Search View fields | H3: GetAdvancedSearchViewInfoAsync() | H3: GetAdvancedSearchViewUniqueCreatedByAsync | H3: GetAdvancedSearchViewUniqueModifiedByAsync() | H3: GetAdvancedSearchViewUniqueOwnersAsync() | H2: Move SearchContainer


### RelativityaiR
- [Relativity aiR developer considerations] (https://platform.relativity.com/RelativityaiR/Content/RelativityaiR/RelativityOne_developer_considerations.htm): Review considerations for developing and running custom applications in Relativity aiR, including how existing agents, event handlers, custom pages, APIs, and ADS applications behave in the cloud.
  - Second paragraph: If you're familiar with custom development for Relativity, use the information on this page to ensure that your existing applications function properly in a Relativity aiR instance. If you're new to custom development, use these considerations in conjunction with other information about the Relativity APIs to jump start the implementation of your applications. For more information, see Tools and Resources.
  - Headings: H1: Relativity aiR developer considerations | H2: Relativity aiR architectural overview | H2: Infrastructure | H3: Relativity aiR fundamentals | H3: Application integration | H3: SQL server coding considerations | H3: SQL tenant admin operational overview | H3: Analytics servers | H3: Data Grid | H3: Internet Information Services (IIS) and Windows Services | H2: Application development | H3: General best practices for Relativity aiR | H3: Applications with external dependencies | H2: Application performance | H3: Input/Output (I/O) considerations | H3: Azure load balancing considerations | H3: Data storage | H2: Import and store data in Relativity aiR | H3: Import options for Relativity aiR | H3: Cloud data storage | H2: Security considerations | H3: TLS 1.2 support | H3: Customer lockbox and system admin access rights | H2: Relativity aiR Government | H2: Relativity aiR Sandbox

- [Relativity aiR Sandbox] (https://platform.relativity.com/RelativityaiR/Content/RelativityaiR/RelativityOne_Sandbox.htm): Learn how to use a Relativity aiR Sandbox to functionally test custom apps and get early access to breaking changes, including instance URLs, user access, and upgrade notifications.
  - Second paragraph: Instance URLs for the Sandbox environment will be formatted as follows:
  - Headings: H1: Relativity aiR Sandbox | H2: Accessing Sandbox environments | H3: Managing user access to your Sandbox | H2: Upgrades of your Sandbox environments | H3: Sandbox extended downtime windows | H2: Using Sandboxes to troubleshoot custom applications | H2: Differences between production and Sandbox environments | H3: Infrastructure | H3: Sandbox Support policies


### RelativityOne
- [Relativity Other .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/OtherNETAPI.html): Relativity Other .NET API Reference

- [Relativity Other .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/Other_API_Reference.htm): Browse the Relativity Other .NET API reference for the Relativity.Other namespace.
  - Headings: H1: Relativity Other .NET API Reference | H2: Relativity.Other

- [Relativity Shared SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/SharedNETAPI.html): Relativity Shared SDK .NET API Reference

- [Relativity Shared SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/Server_Shared_API_Reference.htm): Browse the Relativity Shared SDK .NET API reference for the Relativity.Shared.SDK namespace.
  - Headings: H1: Relativity Shared SDK .NET API Reference | H2: Relativity.Shared.SDK


### Resource Tasks
- [Query for resources] (https://platform.relativity.com/RelativityaiR/Content/REST_API/Resource_Tasks/Querying_for_resources.htm): To search for data, you can use a variety of query options, including conditions, fields, sorts, and relational fields. These query options have a specific syntax for defining the for defining query conditions. Your query conditions may contain special characters that need to be escaped in your code. By combining the query conditions with the available options, you can perform a variety of simple and complex searches in Relativity.
  - Second paragraph: A successful query returns all the results for small data sets or uses paging to return a subset of results for large data sets. When paging is used, the response includes the first page of data, and a token for retrieving subsequent pages as illustrated in the following example.
  - Headings: H1: Query for resources | H2: Query options | H2: Syntax for query conditions | H3: Wildcard characters | H3: Special characters | H3: Supported data grid query operators | H3: Queries on multiple object fields


### REST API
- [HTTP headers] (https://platform.relativity.com/RelativityaiR/Content/REST_API/HTTP_headers.htm): The Relativity REST API requires a minimal number of standard fields in the HTTP header for a request. For more information about how headers are used, see Supported HTTP methods.
  - Second paragraph: X-CSRF-Header: -Don't leave this header value blank. If you omit this header field, the request fails.
  - Headings: H1: HTTP headers

- [HTTP status codes in Relativity REST APIs] (https://platform.relativity.com/RelativityaiR/Content/REST_API/HTTP_status_codes.htm): The Relativity REST APIs return the common status codes in HTTP responses. This page contains the status codes and their descriptions used in Relativity.
  - Headings: H1: HTTP status codes in Relativity REST APIs

- [Relativity REST API authentication] (https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API_authentication.htm): This Relativity REST API authentication page briefly describes authentication methods that the Relativity REST services support. These methods include basic, cookie, Active Directory, and bearer token authentication.
  - Second paragraph: An authentication header is required for all calls to the REST endpoint.
  - Headings: H1: Relativity REST API authentication | H2: Cookie authentication | H3: Cookie authentication from JavaScript | H2: Bearer token authentication | H3: Bearer Token Authentication | H3: Bearer Access tokens in PowerShell

- [REST API] (https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API.htm): With the introduction of the REST API, Relativity further extends the development options available through the platform. The Relativity REST API is designed to streamline the development of mobile, web-based, and cross-platform applications by leveraging standard features of the Representational State Transfer (REST) architectural model. It provides you with the ability to interact with Relativity resources using the HTTP protocol for transferring requests and responses between client and server.
  - Second paragraph: See the following pages for general concepts:
  - Headings: H1: REST API


### REST API concepts
- [Basic REST API concepts] (https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API_concepts/REST_API_and_RESTful_concepts.htm): The REST API simplifies development by supporting standard HTTP methods, error handling, and other RESTful conventions. It also exposes resources through template URLs. You can use this lightweight platform provided by the REST API to take your software projects to the next level with the development of mobile applications that support common user interactions with Relativity.
  - Second paragraph: See this related page:
  - Headings: H1: REST API overview | H2: REST API features | H2: RESTful concepts | H2: Unique implementation details

- [Relativity REST API architecture] (https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API_concepts/Relativity_REST_API_architecture.htm): Using RESTful architectural conventions, the REST API provides you with the ability to access functionality available through the Services API. The REST API passes requests to the Services API, which handles all interactions with the Relativity business engine. You must set up and configure the Services API before you can use the REST API.
  - Second paragraph: The REST API uses named pipes to communicate with the Services API. This communication method offers a fast, in-memory service connection designed to minimize latency in calls made between the two services. Since the system uses named pipes on a localhost, the REST and the Services endpoints must be located on the same machine. Relativity has made significant performance improvements to Services API ensuring that a fast and efficient connection exists between the services. The following diagram illustrates the interconnections between the REST and Services APIs.
  - Headings: H1: Relativity REST API architecture


### REST services
- [Folder Manager  (REST)] (https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_services/Folder_Manager_service.htm): Use the Folder Manager REST service to create, update, move, query, and delete folders and retrieve folder trees, with a .NET client code sample and base URL.
  - Second paragraph: You can also use the Relativity Services API to create, update, delete, and query for folders. For more information, see Folder Manager  (.NET).
  - Headings: H1: Folder Manager  (REST) | H2: Client code sample | H3: HTTP headers and status codes | H2: Create a folder | H2: Update a folder | H2: Delete unused folders | H2: Query for folders | H2: Helper methods | H3: Retrieve workspace root Folder | H3: Retrieve subfolders | H3: Retrieve expanded Folder nodes | H3: Get folder access status | H2: Move folders

- [Search Container Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_services/Search_Container_Manager_service.htm): This topic describes how to interact with the Relativity SearchContainer object using the REST API.
  - Second paragraph: You can only use the POST method when interacting with the service.
  - Headings: H1: Search Container Manager (REST) | H2: Client code sample | H2: Create | H2: Read | H2: Update | H2: Delete | H2: Query | H2: Move | H2: Get folder content | H3: GetSearchContainerItemsAsync | H3: GetChildSearchContainersAsync | H2: Retrieve expanded search container nodes | H3: GetSearchContainerTreeAsync | H3: GetFilteredSearchContainerTreeAsync | H2: Retrieve Advanced Search View fields | H3: GetAdvancedSearchViewInfoAsync | H3: GetAdvancedSearchViewUniqueCreatedByAsync | H3: GetAdvancedSearchViewUniqueModifiedByAsync | H3: GetAdvancedSearchViewUniqueOwnersAsync


### Review
- [Batch Sets Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batch_Sets_Manager_API.htm): Use the Batch Sets Manager .NET API to create, read, update, and delete batch sets and to create and purge their batches.
  - Second paragraph: The Batch Sets Manager API exposes CRUD operations for batch sets. It also supports creating and purging batches for a batch set. As a sample use case, you could use the Batch Sets Manager API to implement an application that programmatically creates a batch set and the batches contained in it.
  - Headings: H1: Batch Sets Manager (.NET) | H2: Fundamentals for the Batch Sets Manager API | H3: Methods | H3: Classes and enumerations | H2: Create a batch set | H2: Read a batch set | H2: Update a batch set | H2: Delete a batch set | H2: Create batches in a batch set | H2: Remove batches from a batch set

- [Batch Sets Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batch_Sets_Manager_service.htm): Use the Batch Sets Manager REST service to create, read, update, and delete batch sets and to create and purge their batches.
  - Second paragraph: The Batch Sets Manager service exposes CRUD operations for batch sets. It also supports creating and purging batches for a batch set. As a sample use case, you could use the Batch Sets Manager service to implement an application that programmatically creates a batch set and the batches contained in it.
  - Headings: H1: Batch Sets Manager (REST) | H2: Guidelines for the Batch Sets Manager service | H3: URLs | H2: Client code sample | H2: Create a batch set | H3: Request field descriptions | H3: Sample JSON request | H3: Response field descriptions | H3: Sample JSON response | H2: Read a batch set | H3: Sample JSON response | H2: Update a batch set | H3: Sample JSON request | H2: Delete a batch set | H2: Create batches | H2: Purge batches

- [Batches Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batches_Manager_API.htm): Use the Batches Manager .NET API to retrieve information about batches and to check batches in and out on behalf of reviewers.
  - Second paragraph: The Batches Manager API supports retrieving information about existing batches as well as checking batches in and out. As a sample use case, you could use the Batches Manager API to implement application logic that automatically checks batches in and out on behalf of reviewers.
  - Headings: H1: Batches Manager (.NET) | H2: Fundamentals for the Batches Manager API | H3: Methods | H3: Classes and enumerations | H2: Read a batch | H2: Check out a batch | H2: Check in a batch

- [Batches Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batches_Manager_service.htm): Use the Batches Manager REST service to retrieve information about batches and to check batches in and out on behalf of reviewers.
  - Second paragraph: The Batches Manager service supports retrieving information about existing batches as well as checking batches in and out. As a sample use case, you could use the Batches Manager service to implement application logic that automatically checks batches in and out on behalf of reviewers.
  - Headings: H1: Batches Manager (REST) | H2: Guidelines for the Batches Manager service | H3: URLs | H2: Client code sample | H2: Read a batch | H2: Check out a batch | H2: Check in a batch

- [Keyboard Shortcuts Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Review/Keyboard_Shortcuts_Manager_API.htm): Use the Keyboard Shortcuts Manager .NET API to retrieve the keyboard shortcuts in a workspace, such as those for the system, choices, or fields.
  - Second paragraph: As a sample use case, you might want to implement custom keyboard shortcuts in layouts, such as the review interface. You could use this service to retrieve the information required to attach the appropriate shortcut to a specific field or choice, or for global use at the system level. Users could then navigate with the custom  keyboard shortcuts through fields and choices or trigger global actions with them.
  - Headings: H1: Keyboard Shortcuts Manager (.NET) | H2: Fundamentals for the  Keyboard Shortcuts Manager API | H3: Methods | H3: Classes | H2: Retrieve keyboard shortcuts

- [Keyboard Shortcuts Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Review/Keyboard_Shortcuts_Manager_service.htm): Use the Keyboard Shortcuts Manager REST service to retrieve the keyboard shortcuts in a workspace, such as those for the system, choices, or fields.
  - Second paragraph: As a sample use case, you might want to implement custom keyboard shortcuts in layouts, such as the review interface. You could use this service to retrieve the information required to attach the appropriate shortcut to a specific field or choice, or for global use at the system level. Users could then navigate with the custom  keyboard shortcuts through fields and choices or trigger global actions with them.
  - Headings: H1: Keyboard Shortcuts Manager (REST) | H2: Client code sample | H2: URLs | H2: Retrieve keyboard shortcut | H3: Response field descriptions | H3: Sample JSON response

- [Review .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Review/Review_NET_API_Reference.htm): Browse the Review .NET API reference for the Relativity.Review.SDK, including its interfaces and classes.
  - Headings: H1: Review .NET API Reference | H2: Relativity.Review.SDK

- [Review .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Review/ReviewNETAPI.html): Review .NET API Reference

- [Review Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Review/Review.htm): Find the Review business domain landing page, with links to the Batch Sets, Batches, and Keyboard Shortcuts Manager .NET and REST content and version history.
  - Headings: H1: Review | H2: Current Review API content | H2: Version History


### Review Center
- [Review Center] (https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/Review_Center.htm): Find the Review Center landing page, with links to the Review Center API and REST API reference for accessing Review Center data in a workspace.
  - Second paragraph: The Review Center API provides REST access to Review Center data in your Relativity workspace.
  - Headings: H1: Review Center

- [Review Center (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/Review_Center_API.htm): Use the Review Center REST API to retrieve current queue statistics, such as totals, coded counts, and validation quality metrics, for external reporting or monitoring.
  - Second paragraph: Typical use cases:
  - Headings: H1: Review Center (REST) | H2: Methods | H2: Base URL | H2: Authentication | H3: Bearer Token Authentication | H2: Permissions | H2: Finding workspace and queue IDs | H2: Errors | H2: Response codes | H2: Client code generation | H2: Code samples | H3: Calling the API with PowerShell | H3: Calling the API with C# and HttpClient

- [Review Center REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/ReviewCenterRESTAPI.html): Review Center API REST Reference

- [Review Center REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/Review_Center_API_Reference.htm): Browse the Review Center REST API reference for endpoint details, including queue statistics.
  - Headings: H1: Review Center REST API Reference


### ReviewAPI
- [About Relativity Review] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/About_Relativity_Review.htm): Relativity Review is a document review application that you can use to review, annotate, and code documents in a workspace. It offers performance and extensibility improvements over the current HTML viewer.
  - Second paragraph: Relativity Review introduces changes to the underlying viewer technology that require upgrading existing integrations with the HTML viewer. For more information, see the following pages:
  - Headings: H1: About Relativity Review

- [Accessing the Relativity Review API] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Accessing_the_Relativity_Review_API.htm): Review the following information about how to determine if the Review APIs are available, how to invoke the APIs, and how to listen for events.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Accessing the Relativity Review API | H2: Relativity Review API availability | H2: Verify that Relativity Review is enabled | H2: Listen for ready events

- [Adding Custom Content] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Adding_custom_content.htm): Extensions can add custom UI and behavior to the Review Interface in four main ways:
  - Second paragraph: Cards are panels that appear in various docks around the document viewer — sidebars, top/bottom docks, and accordion panels.
  - Headings: H1: Adding Custom Content | H2: Cards | H2: Registering cards | H2: Card loaders | H3: Custom loader (recommended) | H3: IFrame loader | H3: ViewModel loader | H2: Toolbar controls | H2: Context menu items | H2: Document content overlays

- [Annotations] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Annotations.htm)
  - Headings: H1: Annotations | H2: Index | H3: Enumerations | H3: Interfaces | H3: Type Aliases

- [API] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/API.htm)
  - Headings: H1: API | H2: Index | H3: Enumerations | H3: Interfaces

- [Batches] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Batches.htm)
  - Headings: H1: Batches | H2: Index | H3: Interfaces

- [Building An Extension] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Building_An_Extension.htm): Relativity Review Extensions provide you with the ability to customize user workflows in the document viewer. The process for developing an extension includes completing these tasks:
  - Second paragraph: Use the detailed instructions on this page to learn more about implementing custom extensions.
  - Headings: H1: Building An Extension | H2: Step 1 - Create a Relativity application | H2: Step 2 - Create an extension script | H3: Extension script requirements | H3: Extension script parameters | H3: Extension script example | H2: Step 3 - Upload your extension script to Relativity | H2: Step 4 - Optionally upload other static files to Relativity | H2: Additional considerations

- [Building extensions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Building_extensions.htm): The Review Extensions provide multiple options for customizing the user experience and workflows. The following pages provide detailed information about how to leverage this framework.
  - Second paragraph: See these related pages:
  - Headings: H1: Building extensions

- [Cancellation] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Cancellation.htm)
  - Headings: H1: Cancellation | H2: Index | H3: Classes | H3: Interfaces

- [Card Locations] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Card_Locations.htm): You can create cards at multiple locations within the Review interface. For example, you can place cards on the left or right sides within the Review Interface itself, or on the left, right, or bottom of individual viewers, including Native, Image, Extracted Text, and Productions Viewers. When a user chooses the Pop Out Viewer, a new window opens that contains the selected viewer with the viewer collection and dock layouts on the sides and bottom of it respectively. For information about the viewer UI, see Viewer on the Relativity aiR Documentation site.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Card Locations | H2: Basic layout concepts | H3: Dock | H3: Accordion | H2: Review layout - left | H3: Left accordion in document review | H2: Review layout - right | H3: Right accordion in document review | H2: Viewer collection layout - left | H3: Viewer left dock in document review | H3: Viewer left dock in document preview | H2: Viewer collection layout - right | H3: Viewer right dock in document review | H2: Viewer dock layout - bottom | H3: Dock at bottom of document review interface | H3: Dock at bottom of document preview interface

- [Cards] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Cards_1.htm): Cards provide a flexible and customizable user experience in the Relativity Review application. You can use them to arrange standard and custom content in the Relativity Review Interface. The following UI elements are examples of cards:
  - Second paragraph: This page contains the following information:
  - Headings: H1: Cards | H2: Cards | H2: Define a config object for a card | H2: Create a card | H3: Create cards in response to the ApiReady event | H3: Create a card on the fly | H3: Optionally pass additional arguments during card creation | H2: Card loaders | H3: IFrame cards | H3: Access the card object from within the IFrame | H3: Auto resolve | H3: Custom cards | H2: Communication between cards | H2: Card skeleton | H3: Defining card skeleton | H3: Showing card skeleton explicitly | H3: Hiding card skeleton explicitly | H2: Report errors | H2: Set card states | H2: Synchronize with the viewer

- [Cards] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Cards.htm)
  - Headings: H1: Cards | H2: Index | H3: Enumerations | H3: Interfaces | H3: Type Aliases

- [Changes to Integration Development] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Changes_to_Integration_Development.htm): Use the information on this page to learn about changes to the development process for viewer integrations.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Changes to Integration Development | H2: Legacy versus new review integrations | H3: Relativity Forms Page Interaction event handlers | H3: Relativity Review Extensions | H2: Next steps for migration

- [Class: ContextMenuOption] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Class_ContextMenuOption.htm): The context menu options in a format usable for jquery-context-menu build()
  - Second paragraph: new ContextMenuOption(): ContextMenuOption
  - Headings: H1: Class: ContextMenuOption | H2: Constructors | H3: new ContextMenuOption() | H2: Properties | H3: callback() | H3: disabled | H3: icon? | H3: items? | H3: name | H3: rwcIcon? | H3: rwcIconClass? | H3: rwcIconColor? | H3: visible

- [Class: Cursor] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Class_Cursor.htm): Mouse cursor location
  - Second paragraph: new Cursor(): Cursor
  - Headings: H1: Class: Cursor | H2: Constructors | H3: new Cursor() | H2: Properties | H3: x | H3: y

- [Class: OperationCancelledError] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Class_OperationCancelledError.htm): Error indicating that the operation was cancelled.
  - Second paragraph: new OperationCancelledError(): OperationCancelledError
  - Headings: H1: Class: OperationCancelledError | H2: Extends | H2: Constructors | H3: new OperationCancelledError()

- [Coding] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Coding.htm)
  - Headings: H1: Coding | H2: Index | H3: Enumerations | H3: Interfaces | H3: Type Aliases

- [Coding Card] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Coding_Card.htm): The Coding Card API exposes functionality used to create and manage the coding cards. For the API reference, see ICodingCard.
  - Second paragraph: The following extension script illustrates how to use these features of the Coding Card API:
  - Headings: H1: Coding Card

- [Conditionally Registering Extensions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Conditionally_Registering_Extensions.htm): You can use the viewer mode or the viewer version to conditionally load a Review Extension. Conditional loading is useful when an extension should only run in a particular context or is only compatible with certain versions of the Review Interface.
  - Second paragraph: To conditionally register an extension, use the IExtensionParameters object passed to your extension script. It contains both version information (IVersionInformation) and the application context (ApplicationContext) that determines how the Review Interface is being displayed. To prevent your extension from loading, return undefined from your script.
  - Headings: H1: Conditionally Registering Extensions | H2: Example

- [Configuration] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Configuration.htm)
  - Headings: H1: Configuration | H2: Index | H3: Enumerations | H3: Interfaces | H3: Type Aliases

- [Content Highlighting Framework] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Content_Highlighting_Framework.htm): This page contains the following information:
  - Second paragraph: The Content Highlighting Framework streamlines the workflow for building consistent, maintainable, and performant, highlighting features that enrich the document review experience with both text-based and coordinate-based highlights on document content.
  - Headings: H1: Content Highlighting Framework | H2: Overview | H3: Content highlighting features | H3: Getting Started | H3: Controlling feature availability | H3: Enabling features in specific viewer types | H2: Render functions | H3: Render function basics | H3: Render function data retrieval | H3: Render function highlighting | H2: Highlighting | H3: Highlight sets | H3: Highlights | H3: Controlling highlight visibility | H3: Highlighting events | H2: Content highlighting cards | H3: The "late-open" problem | H3: Defining the card | H3: Accessing the Content Highlighting Card API | H3: Using the Content Highlighting Card API | H3: Controlling card visibility | H3: Passing custom data from render functions to highlighting cards | H2: Syncing text highlights across viewer types | H3: Challenges with cross-viewer text highlighting | H3: Best practices for syncing cross-viewer text highlights

- [ContentHighlighting] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ContentHighlighting.htm)
  - Headings: H1: ContentHighlighting | H2: Index | H3: Enumerations | H3: Interfaces | H3: Type Aliases

- [Context Menus] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Context_Menus.htm): The Relativity Review API exposes functionality for creating and managing the right-click context menus in the document viewer. It also supports extending the functionality available in context menus. Relativity Extensions provides a framework used when making these customizations.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Context Menus | H2: Add context menu items | H2: Additional configurations

- [ContextMenu] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ContextMenu.htm)
  - Headings: H1: ContextMenu | H2: Index | H3: Classes | H3: Interfaces

- [ConvenienceApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ConvenienceApi.htm)
  - Headings: H1: ConvenienceApi | H2: Index | H3: Interfaces

- [Creating Viewer Types] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Creating_Viewer_Types.htm): The viewer types are built on the card framework, so you implement them as a type IViewerCard.
  - Second paragraph: Prerequisites: Before creating a custom viewer type, review the information about cards in Card Framework. See Viewer Architecture for an overview about how cards are used in viewer types.
  - Headings: H1: Creating Viewer Types | H2: Step 1 - Create a viewer card definition | H3: viewerType property | H3: createInstance property | H3: supportsItem property | H2: Step 2 - Implement the viewer card instance | H2: Step 3 - Register the viewer card definition | H2: Next steps

- [Custom Viewer Types] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Custom_Viewer_Types.htm): In the Relativity Review Interface, extensions can register custom viewer types. These viewer types may complement core viewer types. For example, they might provide additional viewer tab options in the core viewers, or they might entirely replace core viewer types in certain situations.
  - Second paragraph: Common use cases for a custom viewer type include:
  - Headings: H1: Custom Viewer Types

- [Document] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Document.htm)
  - Headings: H1: Document | H2: Index | H3: Enumerations | H3: Interfaces

- [DocumentActions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/DocumentActions.htm)
  - Headings: H1: DocumentActions | H2: Index | H3: Interfaces

- [DocumentHistory] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/DocumentHistory.htm)
  - Headings: H1: DocumentHistory | H2: Index | H3: Interfaces

- [DocumentList] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/DocumentList.htm)
  - Headings: H1: DocumentList | H2: Index | H3: Interfaces

- [ECMAScript requirements] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ECMAScript_requirements.htm): The Review Interface does not transpile extension scripts. The script you deliver must be compatible with your target browsers — you are responsible for ensuring this.
  - Second paragraph: If you are writing your extension in TypeScript or using modern JavaScript syntax, use a bundler (such as esbuild or webpack) to compile your source to browser-compatible JavaScript before deploying. The bundler's output target determines browser compatibility, not the source language.
  - Headings: H1: ECMAScript requirements | H2: Browser compatibility references

- [Enumeration: AnnotationType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_AnnotationType.htm): Relativity IAnnotation Type
  - Second paragraph: Highlight: "highlight"
  - Headings: H1: Enumeration: AnnotationType | H2: Enumeration Members | H3: Highlight | H3: Redaction

- [Enumeration: AnnotationVisibilityType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_AnnotationVisibilityType.htm): Specifies whether IAnnotations are visible, transparent, or not visible.
  - Second paragraph: This is specific to the image viewer and does not apply to document productions or Save As PDF
  - Headings: H1: Enumeration: AnnotationVisibilityType | H2: Enumeration Members | H3: Hidden | H3: Transparent | H3: Visible

- [Enumeration: ApplicationContext] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ApplicationContext.htm): Context the application is currently running in
  - Second paragraph: This is used to determine which features are enabled/disabled.
  - Headings: H1: Enumeration: ApplicationContext | H2: Enumeration Members | H3: ClassicEmbedded | H3: Embedded | H3: ExternalStandalone | H3: Mobile | H3: Preview | H3: ReviewInterface

- [Enumeration: ApplicationLifecycleEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ApplicationLifecycleEventType.htm): Top-level event types raised by IReviewInterfaceApi
  - Second paragraph: Activated: "activated"
  - Headings: H1: Enumeration: ApplicationLifecycleEventType | H2: Enumeration Members | H3: Activated | H3: ApiReady | H3: CanDeactivate | H3: CanTeardown | H3: Deactivated | H3: Ready | H3: Teardown

- [Enumeration: ApplicationWindowEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ApplicationWindowEventType.htm): Event types raised by IApplicationWindow
  - Second paragraph: CanClose: "canclose"
  - Headings: H1: Enumeration: ApplicationWindowEventType | H2: Enumeration Members | H3: CanClose | H3: Close | H3: Resized

- [Enumeration: AuthMode] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_AuthMode.htm): Authentication mode used for communicating with services
  - Second paragraph: BearerToken: "bearertoken"
  - Headings: H1: Enumeration: AuthMode | H2: Enumeration Members | H3: BearerToken | H3: Cookie

- [Enumeration: BorderStyle] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_BorderStyle.htm): Annotation Border Style
  - Second paragraph: Border line style options
  - Headings: H1: Enumeration: BorderStyle | H2: Enumeration Members | H3: dash | H3: dashdot | H3: dashdotdot | H3: dot | H3: none | H3: solid

- [Enumeration: CardBannerType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CardBannerType.htm): Card banner type
  - Second paragraph: HTML: "html"
  - Headings: H1: Enumeration: CardBannerType | H2: Enumeration Members | H3: HTML | H3: Message

- [Enumeration: CardLayoutId] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CardLayoutId.htm): Card layout options
  - Second paragraph: Overlay: "overlay"
  - Headings: H1: Enumeration: CardLayoutId | H2: Enumeration Members | H3: Overlay | H3: Popout | H3: Review | H3: SmartHighlights | H3: ViewerCollection | H3: ViewerDock

- [Enumeration: CardStatus] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CardStatus.htm): Indicates the loading status of an ICard
  - Second paragraph: Failed: "failed"
  - Headings: H1: Enumeration: CardStatus | H2: Enumeration Members | H3: Failed | H3: Loaded | H3: Loading | H3: Uninitialized | H3: Unloaded | H3: Unloading

- [Enumeration: ChoiceFieldType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ChoiceFieldType.htm): Multiple: 1
  - Second paragraph: Single: 0
  - Headings: H1: Enumeration: ChoiceFieldType | H2: Enumeration Members | H3: Multiple | H3: Single

- [Enumeration: ComponentConflictBehavior] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ComponentConflictBehavior.htm): Defines extension behavior when conflicts are detected between multiple extensions
  - Second paragraph: Fail: "fail"
  - Headings: H1: Enumeration: ComponentConflictBehavior | H2: Enumeration Members | H3: Fail | H3: Register | H3: Unregister

- [Enumeration: ConfigurationEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ConfigurationEventType.htm): Event types raised by the IConfigurationService
  - Second paragraph: ConfigurationChanged: "configurationchanged"
  - Headings: H1: Enumeration: ConfigurationEventType | H2: Enumeration Members | H3: ConfigurationChanged

- [Enumeration: ConfigurationSettingName] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ConfigurationSettingName.htm): The names of the configurations that fire events when they change
  - Second paragraph: previewCustomConfiguration: "previewCustomConfiguration"
  - Headings: H1: Enumeration: ConfigurationSettingName | H2: Enumeration Members | H3: previewCustomConfiguration | H3: reviewMode

- [Enumeration: ContentComparisonResult] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ContentComparisonResult.htm): Content comparison result types
  - Second paragraph: NewQueueItem: "newqueueitem"
  - Headings: H1: Enumeration: ContentComparisonResult | H2: Enumeration Members | H3: NewQueueItem | H3: NewViewerContent | H3: NewViewerType | H3: SameContentNoReload | H3: SameContentWithReload

- [Enumeration: ContentType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ContentType.htm): Describes the type of content being displayed by a IViewerCollection
  - Second paragraph: CollectionError: "collectionerror"
  - Headings: H1: Enumeration: ContentType | H2: Enumeration Members | H3: CollectionError | H3: EmptyQueue | H3: QueueItem | H3: UnsupportedItem | H3: ViewerError

- [Enumeration: CustomStatusPillState] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CustomStatusPillState.htm): Status options that indicate conversion status to the user
  - Second paragraph: Complete: "complete"
  - Headings: H1: Enumeration: CustomStatusPillState | H2: Enumeration Members | H3: Complete | H3: Error | H3: InProgress | H3: None

- [Enumeration: DrawingToolType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_DrawingToolType.htm): Mouse tool type for interacting with a document that has been loaded into an IViewerCardInstance
  - Second paragraph: Annotation: "annotation"
  - Headings: H1: Enumeration: DrawingToolType | H2: Enumeration Members | H3: Annotation | H3: Selection

- [Enumeration: DRMFileIdType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_DRMFileIdType.htm): FI_DRM_EXCEL: 1458
  - Second paragraph: FI_DRM_EXCEL2007: 1459
  - Headings: H1: Enumeration: DRMFileIdType | H2: Enumeration Members | H3: FI_DRM_EXCEL | H3: FI_DRM_EXCEL2007 | H3: FI_DRM_POWERPOINT | H3: FI_DRM_POWERPOINT2007 | H3: FI_DRM_UNKNOWN | H3: FI_DRM_WORD | H3: FI_DRM_WORD2007

- [Enumeration: ErrorCategory] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ErrorCategory.htm): Error categories for card errors
  - Second paragraph: ApplicationException: "applicationexception"
  - Headings: H1: Enumeration: ErrorCategory | H2: Enumeration Members | H3: ApplicationException | H3: Network | H3: Other | H3: Timeout

- [Enumeration: ErrorImageOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ErrorImageOptions.htm): Available images to display in a full screen error
  - Second paragraph: docFailUpdated: "DocFailUpdated.png"
  - Headings: H1: Enumeration: ErrorImageOptions | H2: Enumeration Members | H3: docFailUpdated | H3: docHelpUpdated | H3: docMissingUpdated | H3: docWarning | H3: docZeroByte | H3: notesFailedToLoad

- [Enumeration: ErrorSubCategory] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ErrorSubCategory.htm): Card error sub-categories
  - Second paragraph: ConfigurationError: "configurationerror"
  - Headings: H1: Enumeration: ErrorSubCategory | H2: Enumeration Members | H3: ConfigurationError | H3: FailedToSave | H3: OutOfSync | H3: ValidationError

- [Enumeration: ExtensionStatus] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ExtensionStatus.htm): IExtension status information
  - Second paragraph: Disabled: "disabled"
  - Headings: H1: Enumeration: ExtensionStatus | H2: Enumeration Members | H3: Disabled | H3: Error | H3: Loaded | H3: Unloaded

- [Enumeration: FileIdType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FileIdType.htm): FileIdType Type
  - Second paragraph: FI_DONTVIEW: 4006
  - Headings: H1: Enumeration: FileIdType | H2: Enumeration Members | H3: FI_DONTVIEW | H3: FI_UNKNOWN | H3: FI_ZEROBYTEFILE

- [Enumeration: FilterType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FilterType.htm): Enumeration of types of filters for the filter pane
  - Second paragraph: Conversation: "conversation"
  - Headings: H1: Enumeration: FilterType | H2: Enumeration Members | H3: Conversation | H3: Date | H3: DateTime | H3: Event | H3: Metadata | H3: Participant | H3: Time

- [Enumeration: FontStyle] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FontStyle.htm): Annotation Font Style
  - Second paragraph: Font style options for text redactions or custom annotations
  - Headings: H1: Enumeration: FontStyle | H2: Enumeration Members | H3: bold | H3: italic | H3: normal | H3: strikeout | H3: underline

- [Enumeration: FontWeight] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FontWeight.htm): bold: "bold"
  - Second paragraph: normal: "normal"
  - Headings: H1: Enumeration: FontWeight | H2: Enumeration Members | H3: bold | H3: normal

- [Enumeration: HiddenContentType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HiddenContentType.htm): Specifies whether HiddenContentTypes are turned on or off
  - Second paragraph: This is specific to the native viewer
  - Headings: H1: Enumeration: HiddenContentType | H2: Enumeration Members | H3: LayerOff | H3: LayerOn

- [Enumeration: HighlightActivationMode] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightActivationMode.htm): The method used to indicate that the highlight is active
  - Second paragraph: box: "box"
  - Headings: H1: Enumeration: HighlightActivationMode | H2: Enumeration Members | H3: box | H3: disabled | H3: hatch | H3: none | H3: opacity

- [Enumeration: HighlightImage] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightImage.htm): The image associated with a highlight
  - Second paragraph: cross: "cross"
  - Headings: H1: Enumeration: HighlightImage | H2: Enumeration Members | H3: cross | H3: none

- [Enumeration: HighlightServiceEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightServiceEventType.htm): Event types raised by the viewer IViewerCardInstance
  - Second paragraph: PersistentHighlightTermAdded: "persistenthighlighttermadded"
  - Headings: H1: Enumeration: HighlightServiceEventType | H2: Enumeration Members | H3: PersistentHighlightTermAdded | H3: RecentSearchSetExpandedStateUpdated | H3: RecentSearchSetVisibilityUpdated | H3: RecentSearchTermAdded | H3: RecentSearchTermCleared | H3: RecentSearchTermCountUpdated | H3: RecentSearchTermVisibilityUpdated

- [Enumeration: HighlightSubType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightSubType.htm): Highlight Annotation Sub-Type
  - Second paragraph: Highlight style options
  - Headings: H1: Enumeration: HighlightSubType | H2: Enumeration Members | H3: Blue | H3: Green | H3: Orange | H3: Pink | H3: Purple | H3: Yellow

- [Enumeration: IExtensionSource] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_IExtensionSource.htm): adsApplication: "ads-application"
  - Second paragraph: Indicates the extension is being loaded from resource files tied to a RAP
  - Headings: H1: Enumeration: IExtensionSource | H2: Enumeration Members | H3: adsApplication | H3: cloud

- [Enumeration: ImageViewerEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ImageViewerEventType.htm): Event types raised by the IImageViewer
  - Second paragraph: AnnotationAdded: "annotationadded"
  - Headings: H1: Enumeration: ImageViewerEventType | H2: Enumeration Members | H3: AnnotationAdded | H3: AnnotationDeleted | H3: AnnotationMoved | H3: AnnotationSelection | H3: AnnotationsReloaded | H3: AnnotationUpdated | H3: MarkupSetChanged | H3: RedactionTextSizeChanged

- [Enumeration: ImagingServiceEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ImagingServiceEventType.htm): Event types raised by the viewer IImagingService
  - Second paragraph: ImagesDeleted: "imagesdeleted"
  - Headings: H1: Enumeration: ImagingServiceEventType | H2: Enumeration Members | H3: ImagesDeleted | H3: ImagingCompleted | H3: ImagingServiceUpdated | H3: ImagingStarted | H3: NewImageUploaded

- [Enumeration: InterfaceConfiguration] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_InterfaceConfiguration.htm): Describes which components of the interface are enabled and which are disabled
  - Second paragraph: Embedded: "embedded"
  - Headings: H1: Enumeration: InterfaceConfiguration | H2: Enumeration Members | H3: Embedded | H3: ExternalStandalone | H3: Full | H3: Mobile | H3: Preview | H3: ViewerOnly | H3: ViewerWithToolbar

- [Enumeration: KeyboardShortcutEvents] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_KeyboardShortcutEvents.htm): Event types raised by Keyboard Shortcuts
  - Second paragraph: mousetrapAdded: "mousetrapAdded"
  - Headings: H1: Enumeration: KeyboardShortcutEvents | H2: Enumeration Members | H3: mousetrapAdded | H3: mousetrapRemoved

- [Enumeration: LineType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_LineType.htm): dash: "dash"
  - Second paragraph: dashdot: "dashdot"
  - Headings: H1: Enumeration: LineType | H2: Enumeration Members | H3: dash | H3: dashdot | H3: dashdotdot | H3: dot | H3: none | H3: solid

- [Enumeration: LongTextViewerEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_LongTextViewerEventType.htm): Event types raised by the ILongTextViewer
  - Second paragraph: WhitespaceTabWidth: "whitespacetabwidth"
  - Headings: H1: Enumeration: LongTextViewerEventType | H2: Enumeration Members | H3: WhitespaceTabWidth

- [Enumeration: NativeServiceEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_NativeServiceEventType.htm): Event types raised by the viewer INativeService
  - Second paragraph: NewNativeAdded: "newnativeadded"
  - Headings: H1: Enumeration: NativeServiceEventType | H2: Enumeration Members | H3: NewNativeAdded

- [Enumeration: NotificationLevel] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_NotificationLevel.htm): Specifies the level at which a Notification will show.
  - Second paragraph: Error: "error"
  - Headings: H1: Enumeration: NotificationLevel | H2: Enumeration Members | H3: Error | H3: Info | H3: Success | H3: Warning

- [Enumeration: PageLayoutMode] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_PageLayoutMode.htm): Options for how the IViewerCardInstance will display documents with multiple pages
  - Second paragraph: Continuous: "continuous"
  - Headings: H1: Enumeration: PageLayoutMode | H2: Enumeration Members | H3: Continuous | H3: FacingContinuous | H3: Single

- [Enumeration: PreloadServiceEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_PreloadServiceEventType.htm): Event types raised by IPreloadService
  - Second paragraph: ItemsPreloaded: "itemspreloaded"
  - Headings: H1: Enumeration: PreloadServiceEventType | H2: Enumeration Members | H3: ItemsPreloaded | H3: ItemsPreloading

- [Enumeration: PreviewApiEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_PreviewApiEventType.htm): Event types raised by the IPreviewApi
  - Second paragraph: Popin: "popin"
  - Headings: H1: Enumeration: PreviewApiEventType | H2: Enumeration Members | H3: Popin | H3: Popout

- [Enumeration: ProductionType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ProductionType.htm): ProductionType Type
  - Second paragraph: Image: "image"
  - Headings: H1: Enumeration: ProductionType | H2: Enumeration Members | H3: Image | H3: Native | H3: PDF | H3: RedactNative

- [Enumeration: QueueEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueueEventType.htm): Event types raised by IQueue
  - Second paragraph: AddItemsRequest: "additemsrequest"
  - Headings: H1: Enumeration: QueueEventType | H2: Enumeration Members | H3: AddItemsRequest | H3: Deleted | H3: DeleteRequested | H3: ItemsAdded | H3: ItemsDeleted | H3: NameUpdated | H3: PointerCreated

- [Enumeration: QueuePointerActivationStatus] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueuePointerActivationStatus.htm): Statuses describing the ready-state of a queue pointer
  - Second paragraph: Activated: "activated"
  - Headings: H1: Enumeration: QueuePointerActivationStatus | H2: Enumeration Members | H3: Activated | H3: Activating | H3: NotActivated

- [Enumeration: QueuePointerEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueuePointerEventType.htm): Event types raised by the IQueuePointer
  - Second paragraph: Activated: "activated"
  - Headings: H1: Enumeration: QueuePointerEventType | H2: Enumeration Members | H3: Activated | H3: Deleted | H3: DeleteRequested | H3: Shifted | H3: UpdateApproved | H3: Updated | H3: UpdateRequested

- [Enumeration: QueueServiceEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueueServiceEventType.htm): Event types raised by the IQueueService
  - Second paragraph: DeleteQueueRequest: "deletequeuerequest"
  - Headings: H1: Enumeration: QueueServiceEventType | H2: Enumeration Members | H3: DeleteQueueRequest | H3: QueueCreated | H3: QueueDeleted

- [Enumeration: RectangleEdge] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RectangleEdge.htm): Card Rectangle Edge
  - Second paragraph: Specifies an edge of a card
  - Headings: H1: Enumeration: RectangleEdge | H2: Enumeration Members | H3: Bottom | H3: Left | H3: Right | H3: Top

- [Enumeration: RectRangeUnits] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RectRangeUnits.htm): pct: "pct"
  - Second paragraph: px: "px"
  - Headings: H1: Enumeration: RectRangeUnits | H2: Enumeration Members | H3: pct | H3: px | H3: tw

- [Enumeration: RedactionMode] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RedactionMode.htm): Redaction Mode
  - Second paragraph: Redaction mode options for dropdown
  - Headings: H1: Enumeration: RedactionMode | H2: Enumeration Members | H3: Basic | H3: FullPage | H3: Inverse | H3: Mass

- [Enumeration: RedactionSubType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RedactionSubType.htm): Redaction Annotation Sub-Type
  - Second paragraph: Redaction style options
  - Headings: H1: Enumeration: RedactionSubType | H2: Enumeration Members | H3: Black | H3: Cross | H3: Inverse | H3: Text | H3: White

- [Enumeration: RelativeOrderType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativeOrderType.htm): aboveEmbeddings: "aboveEmbeddings"
  - Second paragraph: belowEmbeddings: "belowEmbeddings"
  - Headings: H1: Enumeration: RelativeOrderType | H2: Enumeration Members | H3: aboveEmbeddings | H3: belowEmbeddings

- [Enumeration: RelativityFormCustomButtonActionType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormCustomButtonActionType.htm): Relativity Forms Action Types
  - Second paragraph: cancel: "Cancel"
  - Headings: H1: Enumeration: RelativityFormCustomButtonActionType | H2: Enumeration Members | H3: cancel | H3: edit | H3: save | H3: saveAndBack | H3: saveAndNext

- [Enumeration: RelativityFormCustomButtonVisibleMode] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormCustomButtonVisibleMode.htm): Relativity Forms Modes
  - Second paragraph: add: 1
  - Headings: H1: Enumeration: RelativityFormCustomButtonVisibleMode | H2: Enumeration Members | H3: add | H3: edit | H3: view

- [Enumeration: RelativityFormModelName] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormModelName.htm): Relativity Forms Model Names
  - Second paragraph: edit: "edit"
  - Headings: H1: Enumeration: RelativityFormModelName | H2: Enumeration Members | H3: edit | H3: view

- [Enumeration: RelativityFormsEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormsEventType.htm): Relativity Forms Events
  - Second paragraph: afterModalClose: "AfterModalClose"
  - Headings: H1: Enumeration: RelativityFormsEventType | H2: Enumeration Members | H3: afterModalClose | H3: afterSave | H3: afterSaveAndNext | H3: apiReady | H3: beforeModalOpen | H3: eventHandlerError | H3: formError | H3: formReady | H3: startFormLoad | H3: startSave

- [Enumeration: RelativityFormSlotPosition] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormSlotPosition.htm): Relativity Forms Custom Button Slot Positions
  - Second paragraph: left: "left"
  - Headings: H1: Enumeration: RelativityFormSlotPosition | H2: Enumeration Members | H3: left | H3: middle | H3: right

- [Enumeration: RelativityNativeType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityNativeType.htm): Relativity RelativityNativeType Type
  - Second paragraph: RelativityShortMessageFormat: "Relativity Short Message Format"
  - Headings: H1: Enumeration: RelativityNativeType | H2: Enumeration Members | H3: RelativityShortMessageFormat | H3: UnknownFormat

- [Enumeration: RelativityQueueItemType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityQueueItemType.htm): Relativity built-in queue item types
  - Second paragraph: Document: "document"
  - Headings: H1: Enumeration: RelativityQueueItemType | H2: Enumeration Members | H3: Document | H3: RDOFile | H3: ShortMessage

- [Enumeration: RelativityViewerEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityViewerEventType.htm): Event types raised by Relativity IViewerCardInstances
  - Second paragraph: AddComment: "addComment"
  - Headings: H1: Enumeration: RelativityViewerEventType | H2: Enumeration Members | H3: AddComment | H3: FeaturesInitialized | H3: FilterDrawerToggle | H3: FiltersUpdated | H3: PageChange | H3: PageCountChange | H3: Search | H3: ShowHiddenContent | H3: ThumbnailDrawerToggle | H3: TranscriptDocumentLoaded | H3: TranscriptLoadFailed | H3: TranscriptViewOpened | H3: Zoom

- [Enumeration: RelativityViewerType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityViewerType.htm): Relativity viewer types
  - Second paragraph: Image: "image"
  - Headings: H1: Enumeration: RelativityViewerType | H2: Enumeration Members | H3: Image | H3: Native | H3: PDF | H3: Production | H3: Text

- [Enumeration: RenderStatus] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RenderStatus.htm): Complete: "complete"
  - Second paragraph: Failed: "failed"
  - Headings: H1: Enumeration: RenderStatus | H2: Enumeration Members | H3: Complete | H3: Failed | H3: InProgress | H3: NotStarted

- [Enumeration: ReviewInterfaceEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ReviewInterfaceEventType.htm): Top-level event types raised by IReviewInterfaceApi
  - Second paragraph: Activated: "activated"
  - Headings: H1: Enumeration: ReviewInterfaceEventType | H2: Enumeration Members | H3: Activated | H3: ApiReady | H3: CanDeactivate | H3: CanTeardown | H3: Deactivated | H3: Ready | H3: Teardown

- [Enumeration: ReviewInterfaceWindowEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ReviewInterfaceWindowEventType.htm): DOM window event types raised by the Review Interface.
  - Second paragraph: ApiReady: "apiready"
  - Headings: H1: Enumeration: ReviewInterfaceWindowEventType | H2: Enumeration Members | H3: ApiReady

- [Enumeration: ReviewMode] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ReviewMode.htm): The supported review modes in the review interface
  - Second paragraph: edit: "Edit"
  - Headings: H1: Enumeration: ReviewMode | H2: Enumeration Members | H3: edit | H3: view

- [Enumeration: RwcCopyFromPreviousState] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RwcCopyFromPreviousState.htm): Copy From Previous Indicator states
  - Second paragraph: AVAILABLE: "available"
  - Headings: H1: Enumeration: RwcCopyFromPreviousState | H2: Enumeration Members | H3: AVAILABLE | H3: COPIED | H3: NOTHING_TO_COPY

- [Enumeration: SizeUnits] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_SizeUnits.htm): PT: "pt"
  - Second paragraph: Points
  - Headings: H1: Enumeration: SizeUnits | H2: Enumeration Members | H3: PT | H3: PX

- [Enumeration: SkeletonOverlayType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_SkeletonOverlayType.htm): Skeleton overlay types that can be shown during navigation and jump-in
  - Second paragraph: Generic: "generic"
  - Headings: H1: Enumeration: SkeletonOverlayType | H2: Enumeration Members | H3: Generic

- [Enumeration: SlicingStatus] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_SlicingStatus.htm): Status options that indicate conversion status to the user
  - Second paragraph: Complete: "complete"
  - Headings: H1: Enumeration: SlicingStatus | H2: Enumeration Members | H3: Complete | H3: None | H3: Slicing

- [Enumeration: StreamingStatus] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_StreamingStatus.htm): Status options that indicate conversion status to the user
  - Second paragraph: Complete: "complete"
  - Headings: H1: Enumeration: StreamingStatus | H2: Enumeration Members | H3: Complete | H3: Error | H3: None | H3: Streaming

- [Enumeration: TextSearchDirection] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchDirection.htm): Down: "down"
  - Second paragraph: Search from the beginning towards the end
  - Headings: H1: Enumeration: TextSearchDirection | H2: Enumeration Members | H3: Down | H3: Up

- [Enumeration: TextSearchMode] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchMode.htm): Specifies how the search term is interpreted
  - Second paragraph: dtsearch: "dtsearch"
  - Headings: H1: Enumeration: TextSearchMode | H2: Enumeration Members | H3: dtsearch | H3: literal | H3: literalstar | H3: strict

- [Enumeration: TextSearchStemmer] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchStemmer.htm): dtsearch: "dtsearch"
  - Second paragraph: none: "none"
  - Headings: H1: Enumeration: TextSearchStemmer | H2: Enumeration Members | H3: dtsearch | H3: none | H3: porter

- [Enumeration: TextSearchUtilityMode] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchUtilityMode.htm): Determines how the search term is interpreted
  - Second paragraph: dtSearch: "dtsearch"
  - Headings: H1: Enumeration: TextSearchUtilityMode | H2: Enumeration Members | H3: dtSearch | H3: Literal | H3: LiteralStar | H3: PHSTerms | H3: String

- [Enumeration: TextSearchUtilityStemmer] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchUtilityStemmer.htm): Determines which stemming algorithm will be used.
  - Second paragraph: dtSearch: "dtsearch"
  - Headings: H1: Enumeration: TextSearchUtilityStemmer | H2: Enumeration Members | H3: dtSearch | H3: None | H3: Porter

- [Enumeration: ToolbarControlAlignment] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ToolbarControlAlignment.htm): Toolbar Control Alignment
  - Second paragraph: Options for which slot to add a toolbar control to
  - Headings: H1: Enumeration: ToolbarControlAlignment | H2: Enumeration Members | H3: Center | H3: Left | H3: Right | H3: RightPermanent

- [Enumeration: ToolbarControlType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ToolbarControlType.htm): Toolbar Control Type
  - Second paragraph: Type for the tool bar control
  - Headings: H1: Enumeration: ToolbarControlType | H2: Enumeration Members | H3: Button | H3: Collection | H3: Custom | H3: RWCButton | H3: RWCToggleButton | H3: TabCollection

- [Enumeration: ToolTipPosition] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ToolTipPosition.htm): ToolTip position
  - Second paragraph: Specifies the tool tip position relative to the html element
  - Headings: H1: Enumeration: ToolTipPosition | H2: Enumeration Members | H3: Auto | H3: Bottom | H3: BottomEnd | H3: BottomStart | H3: Left | H3: LeftEnd | H3: LeftStart | H3: Right | H3: RightEnd | H3: RightStart | H3: Top | H3: TopEnd | H3: TopStart

- [Enumeration: ViewerCollectionEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerCollectionEventType.htm): Event types raised by IViewerCollections
  - Second paragraph: ActiveViewerChanged: "activeViewerChanged"
  - Headings: H1: Enumeration: ViewerCollectionEventType | H2: Enumeration Members | H3: ActiveViewerChanged | H3: BootstrapCompleted | H3: BootstrapStarted | H3: ContentChangeApproved | H3: ContentChanged | H3: ContentChanging | H3: DocumentMetaDataChanged | H3: QueuePointerChanged | H3: ReloadCompleted | H3: SkeletonHidden | H3: SkeletonShown | H3: ToolbarControlsEnabled | H3: ViewerActivated | H3: ViewerDeactivated | H3: ViewerLoadedItem

- [Enumeration: ViewerCollectionSkeletonType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerCollectionSkeletonType.htm): Describes the scenario under which the skeleton was shown
  - Second paragraph: Bootstrap: "bootstrap"
  - Headings: H1: Enumeration: ViewerCollectionSkeletonType | H2: Enumeration Members | H3: Bootstrap | H3: Navigation

- [Enumeration: ViewerHighlightEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerHighlightEventType.htm): Event types raised by the viewer IViewerCardInstance
  - Second paragraph: PersistentHighlightCountUpdated: "persistentHighlightCountUpdated"
  - Headings: H1: Enumeration: ViewerHighlightEventType | H2: Enumeration Members | H3: PersistentHighlightCountUpdated | H3: PersistentHighlightDrawerUpdated | H3: PersistentHighlightExpandedUpdated | H3: PersistentHighlightSelectedUpdated | H3: PersistentHighlightsUpdated | H3: PersistentHighlightVisibilityUpdated | H3: RecentSearchSetUpdated

- [Enumeration: ViewerServiceEventType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerServiceEventType.htm): Event types raised by the IViewerService
  - Second paragraph: CollectionCreated: "collectioncreated"
  - Headings: H1: Enumeration: ViewerServiceEventType | H2: Enumeration Members | H3: CollectionCreated | H3: CollectionDeleted | H3: DeleteCollectionRequest

- [Enumeration: ViewerZoomLimit] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerZoomLimit.htm): Viewer Zoom Limits
  - Second paragraph: These refer to the predefined constants for setting and limiting zoom factor
  - Headings: H1: Enumeration: ViewerZoomLimit | H2: Enumeration Members | H3: ZoomDefault | H3: ZoomMaximum | H3: ZoomMinimum | H3: ZoomStep

- [Enumeration: ViewerZoomMode] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerZoomMode.htm): Viewer Zoom Mode enum
  - Second paragraph: These refer to the mode by which the document may be zoomed to fit the screen
  - Headings: H1: Enumeration: ViewerZoomMode | H2: Enumeration Members | H3: default | H3: page | H3: pageheight | H3: pagewidth | H3: percentage

- [Enumeration: VisibilityPersistenceMode] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_VisibilityPersistenceMode.htm): Persistence modes for set group visibility
  - Second paragraph: BrowserSessionStorage: "browsersessionstorage"
  - Headings: H1: Enumeration: VisibilityPersistenceMode | H2: Enumeration Members | H3: BrowserSessionStorage | H3: None

- [Enumeration: VisibilityStatusType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_VisibilityStatusType.htm): Error: "Error"
  - Second paragraph: No: "No"
  - Headings: H1: Enumeration: VisibilityStatusType | H2: Enumeration Members | H3: Error | H3: No | H3: Pending | H3: Yes

- [Error] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Error.htm)
  - Headings: H1: Error | H2: Index | H3: Enumerations | H3: Interfaces

- [Event] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Event.htm)
  - Headings: H1: Event | H2: Index | H3: Interfaces | H3: Type Aliases

- [Executing Custom Code] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Executing_Custom_Code.htm): You can configure extensions to execute custom code at specific application lifecycle events. Your code has access to the full IReviewInterfaceApi when executing.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Executing Custom Code | H2: Custom code execution | H2: Custom code example | H2: Available application lifecycle events

- [Extension JavaScript API] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Extension_JavaScript_API.htm): Use Extension JavaScript API to interact with the Relativity Review Extension framework. You can use it from the extensions themselves and from the developer tools console in the browser.
  - Second paragraph: Additionally, you can perform the following tasks with this API:
  - Headings: H1: Extension JavaScript API | H2: Determine whether the Review Extension framework is enabled | H2: Examine loaded extensions | H3: Retrieve all loaded extensions | H3: Retrieve extensions by ID | H2: Debug extensions via the Extension Debug API | H3: Temporarily disable the Relativity Review extension framework | H3: Temporarily disable specific extensions

- [Extensions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Extensions_1.htm): Review Extensions let you customize the document review experience by adding custom behavior and UI to the Review Interface. Extensions are JavaScript/TypeScript modules that are loaded at startup and have access to the full Review Interface API.
  - Second paragraph: You can use the Review Extensions framework to:
  - Headings: H1: Extensions | H2: In this section

- [Extensions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Extensions.htm)
  - Headings: H1: Extensions | H2: Index | H3: Enumerations | H3: Interfaces

- [FileService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/FileService.htm)
  - Headings: H1: FileService | H2: Index | H3: Enumerations | H3: Interfaces

- [Filter] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Filter.htm)
  - Headings: H1: Filter | H2: Index | H3: Enumerations | H3: Interfaces

- [Function: isAsyncExpirationCache()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Function_isAsyncExpirationCache__.htm): isAsyncExpirationCache<T>(val): val is IAsyncExpirationCache<T>
  - Second paragraph: Type guard to check if a value is an instance of IAsyncExpirationCache
  - Headings: H1: Function: isAsyncExpirationCache() | H2: Type Parameters | H2: Parameters | H2: Returns

- [Highlight] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Highlight.htm)
  - Headings: H1: Highlight | H2: Index | H3: Enumerations | H3: Interfaces

- [Highlights] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Highlights.htm): The Review Interface supports three highlighting approaches. Most extension authors will use transient highlights or the Content Highlighting Framework depending on their use case. Persistent highlight management is a separate feature with a narrower purpose.
  - Second paragraph: Both approaches can be backed by API calls. The Content Highlighting Framework provides a lot of infrastructure you'd otherwise need to build yourself on top of transient highlights — render function invocation, cancellation, caching, cross-viewer sync, and card lifecycle management. If you need that infrastructure, use the framework. If you need more direct control or have simpler requirements, transient highlights give you a lower-level API.
  - Headings: H1: Highlights | H2: Choosing an approach | H2: Persistent Highlighting | H2: Summary

- [Hyperlink] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Hyperlink.htm)
  - Headings: H1: Hyperlink | H2: Index | H3: Interfaces | H3: Type Aliases

- [Interface: CellRangeMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_CellRangeMemento.htm): optionalc1: number
  - Second paragraph: The 0-based index of the leftmost column of the range
  - Headings: H1: Interface: CellRangeMemento | H2: Properties | H3: c1? | H3: c2? | H3: offsets? | H3: r1? | H3: r2? | H3: section? | H3: sheet? | H3: type

- [Interface: ContextMenuItemMap] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ContextMenuItemMap.htm): Holds child context menu items
  - Second paragraph: [key: string]: ContextMenuOption
  - Headings: H1: Interface: ContextMenuItemMap | H2: Indexable

- [Interface: CustomOutsideInViewerOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_CustomOutsideInViewerOptions.htm): Options for features on the custom outside in viewer
  - Second paragraph: optionalcustomStatusPills: ICustomStatusPillConfig[]
  - Headings: H1: Interface: CustomOutsideInViewerOptions | H2: Properties | H3: customStatusPills? | H3: documentMetricKey? | H3: enableContextMenu? | H3: hasHiddenContent? | H3: hasHighlights? | H3: hasHighlightSearch? | H3: hasThumbnails?

- [Interface: FontSize] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_FontSize.htm): readonlyheight: number
  - Second paragraph: readonlyunits: SizeUnits
  - Headings: H1: Interface: FontSize | H2: Properties | H3: height | H3: units

- [Interface: HighlightConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightConfig.htm): Style information for [[Highlight]] objects
  - Second paragraph: activationMode: HighlightActivationMode
  - Headings: H1: Interface: HighlightConfig | H2: Extends | H2: Properties | H3: activationMode | H3: activeStyle? | H3: allowDelete? | H3: allowMove? | H3: allowResize? | H3: borderColor | H3: borderLineType | H3: borderWidth | H3: cssClass | H3: enableDelete | H3: enableMove | H3: enableResize | H3: fillColor | H3: image | H3: inverse | H3: label | H3: labelColor | H3: labelFontFace | H3: labelFontSize | H3: labelFontWeight | H3: redaction | H3: relativeOrder? | H3: reversion | H3: strokeColor | H3: textColor | H3: userData?

- [Interface: HighlightMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightMemento.htm): optionalactivationMode: HighlightActivationMode
  - Second paragraph: Controls how the highlight is rendered when it is active and inactive.
  - Headings: H1: Interface: HighlightMemento | H2: Extends | H2: Properties | H3: activationMode? | H3: activeStyle? | H3: allowDelete? | H3: allowMove? | H3: allowResize? | H3: borderColor? | H3: borderLineType? | H3: borderWidth? | H3: compound? | H3: cssClass? | H3: enableDelete? | H3: enableMove? | H3: enableResize? | H3: fillColor? | H3: highlightId | H3: image? | H3: inverse? | H3: label? | H3: labelColor? | H3: labelFontFace? | H3: labelFontSize? | H3: labelFontWeight? | H3: range | H3: redaction? | H3: relativeOrder? | H3: reversion? | H3: strokeColor? | H3: term? | H3: termContext? | H3: termMetadata? | H3: textColor? | H3: userData? | H3: visible?

- [Interface: HighlightSetMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightSetMemento.htm): optionalconfig: PartialHighlightConfig
  - Second paragraph: The highlight configuration for highlights in this set
  - Headings: H1: Interface: HighlightSetMemento | H2: Properties | H3: config? | H3: highlights | H3: id | H3: metadata | H3: terms? | H3: visible?

- [Interface: HighlightStyle] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightStyle.htm): Style information for [[Highlight]] objects
  - Second paragraph: borderColor: string
  - Headings: H1: Interface: HighlightStyle | H2: Extended by | H2: Properties | H3: borderColor | H3: borderLineType | H3: borderWidth | H3: cssClass | H3: enableDelete | H3: enableMove | H3: enableResize | H3: fillColor | H3: image | H3: label | H3: labelColor | H3: labelFontFace | H3: labelFontSize | H3: labelFontWeight | H3: strokeColor | H3: textColor

- [Interface: IActiveViewerChangedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IActiveViewerChangedEvent.htm): Event data for the ViewerCollectionEventType.ActiveViewerChanged event
  - Second paragraph: currentType: string
  - Headings: H1: Interface: IActiveViewerChangedEvent | H2: Properties | H3: currentType | H3: targetType

- [Interface: IAddItemsRequestEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAddItemsRequestEvent.htm): Event data for the QueueEventType.AddItemsRequest event
  - Second paragraph: index: number
  - Headings: H1: Interface: IAddItemsRequestEvent | H2: Properties | H3: index | H3: items

- [Interface: IAddPersistentHighlightTermsToSetRequest] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAddPersistentHighlightTermsToSetRequest.htm): POST request payload to add terms to a highlight set
  - Second paragraph: optionalbackgroundColor: string
  - Headings: H1: Interface: IAddPersistentHighlightTermsToSetRequest | H2: Properties | H3: backgroundColor? | H3: foregroundColor? | H3: term

- [Interface: IAnnotation] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotation.htm): Relativity markup
  - Second paragraph: optionalcreatedOn: string
  - Headings: H1: Interface: IAnnotation | H2: Properties | H3: createdOn? | H3: customAnnotationData? | H3: guid | H3: height | H3: imageHeight | H3: imageWidth | H3: markupId | H3: markupSet | H3: oiHighlightId? | H3: pageHeight | H3: pageNumber | H3: pageWidth | H3: subType | H3: textData? | H3: type | H3: width | H3: xCoordinate | H3: yCoordinate

- [Interface: IAnnotationChangedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationChangedEvent.htm): Event data for the ImageViewerEventType.AnnotationUpdated event
  - Second paragraph: annotationsChanged: IAnnotation[]
  - Headings: H1: Interface: IAnnotationChangedEvent | H2: Properties | H3: annotationsChanged

- [Interface: IAnnotationDetailsData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationDetailsData.htm): optionalHeight: number
  - Second paragraph: HeightDeltaOldAndNewValue: IAnnotationOldAndNewValue
  - Headings: H1: Interface: IAnnotationDetailsData | H2: Properties | H3: Height? | H3: HeightDeltaOldAndNewValue | H3: HeightOldAndNewValue | H3: MarkupSetArtifactId | H3: PageNumber | H3: Width? | H3: WidthDeltaOldAndNewValue | H3: WidthOldAndNewValue | H3: X? | H3: XDeltaOldAndNewValue | H3: XOldAndNewValue | H3: Y? | H3: YDeltaOldAndNewValue | H3: YOldAndNewValue

- [Interface: IAnnotationHistoryData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationHistoryData.htm): Action: number
  - Second paragraph: ActionName: string
  - Headings: H1: Interface: IAnnotationHistoryData | H2: Properties | H3: Action | H3: ActionName | H3: ArtifactId | H3: Details | H3: TimeStamp | H3: UserId | H3: UserName

- [Interface: IAnnotationLookup] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationLookup.htm): A lookup of IAnnotations for a document by page
  - Second paragraph: Each property name of the lookup is a number corresponding to the 0-based page index. And each property value is an array of IAnnotations on that page
  - Headings: H1: Interface: IAnnotationLookup | H2: Indexable

- [Interface: IAnnotationOldAndNewValue] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationOldAndNewValue.htm): optionalNewValue: number
  - Second paragraph: optionalOldValue: number
  - Headings: H1: Interface: IAnnotationOldAndNewValue | H2: Properties | H3: NewValue? | H3: OldValue?

- [Interface: IAnnotationRectangle] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationRectangle.htm): Information that represents the rectangle an IAnnotation covers
  - Second paragraph: Note that all pixels are measured based on the height and width of the converted page, not the original Relativity Image file.
  - Headings: H1: Interface: IAnnotationRectangle | H2: Properties | H3: height | H3: width | H3: x | H3: y

- [Interface: IAnnotationSelectionEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationSelectionEvent.htm): Event data for the ImageViewerEventType.AnnotationSelection event
  - Second paragraph: selectedAnnotations: IAnnotation[]
  - Headings: H1: Interface: IAnnotationSelectionEvent | H2: Properties | H3: selectedAnnotations

- [Interface: IAnnotationsService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationsService.htm): Class for working with IAnnotations and IMarkupSets
  - Second paragraph: getAnnotationHistory(workspaceId, documentId, annotationId, markupSetId, clientId): Promise<IAnnotationHistoryData[]>
  - Headings: H1: Interface: IAnnotationsService | H2: Methods | H3: getAnnotationHistory() | H3: getAnnotationVisibility() | H3: getAnnotationVisibilityFromSession() | H3: getDefaultMarkupSetData() | H3: getMarkupSetAnnotations() | H3: getMarkupSetData() | H3: getUserDefaultRedactionText() | H3: getUserDefaultRedactionTextSize() | H3: persistNewMarkupSetSelection() | H3: setAnnotationVisibility() | H3: setUserDefaultRedactionText() | H3: setUserDefaultRedactionTextSize()

- [Interface: IApplicationLifecycleService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IApplicationLifecycleService.htm): API for working with the application lifecycle
  - Second paragraph: readonlyisActivated: boolean
  - Headings: H1: Interface: IApplicationLifecycleService | H2: Properties | H3: isActivated | H2: Methods | H3: activate() | H3: canDeactivate() | H3: deactivate() | H3: exitReviewInterface() | H3: exitToRelativityUrl() | H3: returnToDocumentList() | H3: setExitViewerLocation() | H3: setIsActiveOverride()

- [Interface: IApplicationWindow] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IApplicationWindow.htm): readonlyisMain: boolean
  - Second paragraph: Indicates if this window is running Review Interface application.
  - Headings: H1: Interface: IApplicationWindow | H2: Extends | H2: Properties | H3: isMain | H3: isOpen | H3: isRelativityWindow | H3: name | H3: window? | H2: Methods | H3: close() | H3: off() | H3: on() | H3: once()

- [Interface: IApplicationWindowConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IApplicationWindowConfig.htm): Configuration object for creating a new IApplicationWindow.
  - Second paragraph: optionalautoFocus: boolean
  - Headings: H1: Interface: IApplicationWindowConfig | H2: Properties | H3: autoFocus? | H3: features? | H3: isPopup? | H3: name | H3: title? | H3: url?

- [Interface: IAsyncExpirationCache<T>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAsyncExpirationCacheT.htm): • TextendsNonNullable<unknown>
  - Second paragraph: Cache item type (cannot be undefined or null)
  - Headings: H1: Interface: IAsyncExpirationCache<T> | H2: Type Parameters | H2: Properties | H3: isAsyncCache | H2: Methods | H3: addOrUpdate() | H3: get() | H3: has() | H3: howOld() | H3: tryRemove() | H3: updateMaxSize()

- [Interface: IAuditObjectManagerData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAuditObjectManagerData.htm): CurrentStartIndex: number
  - Second paragraph: optionalObjects: IAuditObjectsEntity[]
  - Headings: H1: Interface: IAuditObjectManagerData | H2: Properties | H3: CurrentStartIndex | H3: Objects? | H3: ObjectType | H3: ResultCount | H3: TotalCount

- [Interface: IAuditObjectsEntity] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAuditObjectsEntity.htm): ArtifactID: number
  - Second paragraph: FieldValues: IFieldValuesEntity[]
  - Headings: H1: Interface: IAuditObjectsEntity | H2: Properties | H3: ArtifactID | H3: FieldValues | H3: Guids? | H3: Name

- [Interface: IAuditQueryOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAuditQueryOptions.htm): optionalReturnRawDetails: boolean
  - Headings: H1: Interface: IAuditQueryOptions | H2: Properties | H3: ReturnRawDetails?

- [Interface: IBatchService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IBatchService.htm): Class for working with Batches
  - Second paragraph: getBatchesByDocument(documentId): Promise<number[]>
  - Headings: H1: Interface: IBatchService | H2: Methods | H3: getBatchesByDocument()

- [Interface: ICache<K, V>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICacheK__V.htm): Generic cache implementation for caching data
  - Second paragraph: • KextendsSupportedCacheKeyTypeUnion = string
  - Headings: H1: Interface: ICache<K, V> | H2: Type Parameters | H2: Methods | H3: clear() | H3: delete() | H3: get() | H3: has() | H3: set()

- [Interface: ICancellationToken] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICancellationToken.htm): Cancellation token that can be used to listen for and handle cancellation requests
  - Second paragraph: readonlyisCancellationRequested: boolean
  - Headings: H1: Interface: ICancellationToken | H2: Properties | H3: isCancellationRequested | H2: Methods | H3: offCancellation() | H3: onCancellation() | H3: throwIfCancellationRequested()

- [Interface: ICard] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICard.htm): Card instance
  - Second paragraph: readonlyactive: boolean
  - Headings: H1: Interface: ICard | H2: Extended by | H2: Properties | H3: active | H3: activeFlag | H3: applicationWindow | H3: autoRestore | H3: bottomToolbar? | H3: cardError | H3: config | H3: defaultHeight? | H3: defaultWidth? | H3: dockSkeletonClassName | H3: element? | H3: enabled | H3: errorString? | H3: frame? | H3: hasError | H3: hasNotification | H3: height? | H3: icon | H3: id | H3: instance? | H3: instanceId | H3: instanceIndex | H3: leftToolbar? | H3: loadDeferred | H3: location? | H3: maximized | H3: minHeight | H3: minWidth | H3: order | H3: overlay? | H3: parameters? | H3: popoutInProgress | H3: poppedIn | H3: poppedOut | H3: rightToolbar? | H3: skeletonVisible | H3: status | H3: title | H3: toolbars? | H3: topToolbar? | H3: visible | H3: width? | H3: window | H2: Methods | H3: activate() | H3: bindInstance() | H3: canDeactivate() | H3: completeFrameLoad() | H3: createBanner() | H3: createHtmlBanner() | H3: createToolbar() | H3: deactivate() | H3: disable() | H3: dismissBanner() | H3: dismissBannerByClass() | H3: enable() | H3: failFrameLoad() | H3: hideOverlay() | H3: hideSkeleton() | H3: load() | H3: maximize() | H3: move() | H3: popin() | H3: popout() | H3: remove() | H3: reportError() | H3: restore() | H3: resumeMinHeight() | H3: setActiveFlag() | H3: setStatus() | H3: showNotificationDot() | H3: showOverlay() | H3: showSkeleton() | H3: stateChanged() | H3: suspendMinHeight() | H3: unload() | H3: updateLayout() | H3: waitForDetachment()

- [Interface: ICardBanner] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardBanner.htm): A card banner instance
  - Second paragraph: bannerClass: string
  - Headings: H1: Interface: ICardBanner | H2: Extended by | H2: Properties | H3: bannerClass | H3: card | H3: dismissed | H3: type | H2: Methods | H3: dismiss()

- [Interface: ICardBannerConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardBannerConfig.htm): Common configuration for card banners
  - Second paragraph: optionalbannerClass: string
  - Headings: H1: Interface: ICardBannerConfig | H2: Extended by | H2: Properties | H3: bannerClass?

- [Interface: ICardConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardConfig.htm): Configuration object for defining new cards
  - Second paragraph: optionalappGuid: string
  - Headings: H1: Interface: ICardConfig | H2: Extended by | H2: Properties | H3: appGuid? | H3: appVersion? | H3: autoRestore? | H3: category? | H3: categoryOrder? | H3: createInstance()? | H3: defaultHeight? | H3: defaultWidth? | H3: extends? | H3: icon? | H3: id | H3: loader | H3: location? | H3: minHeight? | H3: minWidth? | H3: order? | H3: singleton? | H3: skeleton? | H3: supportsPopout? | H3: title | H3: toolbarsConfig? | H3: toolTipConfig?

- [Interface: ICardError] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardError.htm): CardError instance
  - Second paragraph: readonlyoptionalcategory: ErrorCategory
  - Headings: H1: Interface: ICardError | H2: Properties | H3: category? | H3: isFatal | H3: stack? | H3: subCategory?

- [Interface: ICardIcon] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardIcon.htm): Card icon definition
  - Second paragraph: optionalclass: string
  - Headings: H1: Interface: ICardIcon | H2: Properties | H3: class? | H3: fileName? | H3: svgIcon? | H3: url?

- [Interface: ICardInstance] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardInstance.htm): Card instance information
  - Second paragraph: optionalcardActivated: (api, card) => void
  - Headings: H1: Interface: ICardInstance | H2: Extended by | H2: Properties | H3: cardActivated()? | H3: cardCanDeactivate()? | H3: cardDeactivated()? | H3: cardError()? | H3: cardLoaded()? | H3: cardLoadState()? | H3: cardMaximized()? | H3: cardResized()? | H3: cardRestored()? | H3: cardSaveState()? | H3: cardUnloaded()?

- [Interface: ICardLoaderConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardLoaderConfig.htm): Card loading information
  - Second paragraph: readonlyoptionalcustom: ICustomCardLoader
  - Headings: H1: Interface: ICardLoaderConfig | H2: Properties | H3: custom? | H3: iframe? | H3: viewmodel?

- [Interface: ICardLocation] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardLocation.htm): Card location information
  - Second paragraph: optionaldockIndex: number
  - Headings: H1: Interface: ICardLocation | H2: Properties | H3: dockIndex? | H3: layoutId? | H3: layoutInstance? | H3: paneId

- [Interface: ICardService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardService.htm): Class for working with ICards by defining types and instantiating/destroying card instances
  - Second paragraph: createCard(cardId, location?, ...parameters?): ICard
  - Headings: H1: Interface: ICardService | H2: Methods | H3: createCard() | H3: defineCard() | H3: destroyCard() | H3: getCard()

- [Interface: ICardSkeleton] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardSkeleton.htm): Custom card loading skeleton
  - Second paragraph: optionaldelay: number
  - Headings: H1: Interface: ICardSkeleton | H2: Properties | H3: delay? | H3: hideSkeleton() | H3: minimum? | H3: showSkeleton()

- [Interface: ICardToolbarConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardToolbarConfig.htm): Card toolbar configuration
  - Second paragraph: optionalclass: string
  - Headings: H1: Interface: ICardToolbarConfig | H2: Properties | H3: class? | H3: edge | H3: id? | H3: title?

- [Interface: ICodingCard] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICodingCard.htm): Class for the coding card
  - Second paragraph: readonlybuttons: IRelativityFormsEnvelopeCustomButtonSettings[]
  - Headings: H1: Interface: ICodingCard | H2: Extends | H2: Properties | H3: buttons | H3: cardActivated()? | H3: cardCanDeactivate()? | H3: cardDeactivated()? | H3: cardError()? | H3: cardLoaded()? | H3: cardLoadState()? | H3: cardMaximized()? | H3: cardResized()? | H3: cardRestored()? | H3: cardSaveState()? | H3: cardUnloaded()? | H3: isEditMode | H3: isLoaded | H2: Methods | H3: addButton() | H3: applyCopyFromPreviousAsync() | H3: cancelAsync() | H3: editAsync() | H3: getConvenienceAPI() | H3: getRelativityFormsEnvelope() | H3: removeButton() | H3: saveAndBackAsync() | H3: saveAndNextAsync() | H3: saveAsync()

- [Interface: ICollectionCreatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICollectionCreatedEvent.htm): Event data for the ViewerServiceEventType.CollectionCreated event
  - Second paragraph: collection: IViewerCollection
  - Headings: H1: Interface: ICollectionCreatedEvent | H2: Properties | H3: collection

- [Interface: ICollectionDeletedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICollectionDeletedEvent.htm): Event data for the ViewerServiceEventType.CollectionDeleted event
  - Second paragraph: collection: IViewerCollection
  - Headings: H1: Interface: ICollectionDeletedEvent | H2: Properties | H3: collection

- [Interface: IColor] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IColor.htm): Color represented as RGBA
  - Second paragraph: A: number
  - Headings: H1: Interface: IColor | H2: Properties | H3: A | H3: B | H3: G | H3: R | H2: Methods | H3: getRGBAString()

- [Interface: IConfigurationChangedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConfigurationChangedEvent.htm): Event data for the ConfigurationEventType.ConfigurationChanged event
  - Second paragraph: newValue: any
  - Headings: H1: Interface: IConfigurationChangedEvent | H2: Properties | H3: newValue | H3: oldValue | H3: settingName

- [Interface: IConfigurationOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConfigurationOptions.htm): Configuration options passed to the ReviewInterface constructor
  - Second paragraph: optionaldeveloperMode: boolean
  - Headings: H1: Interface: IConfigurationOptions | H2: Properties | H3: developerMode? | H3: elementId | H3: embeddedContextKey? | H3: embeddedFeatureConfig? | H3: enabledViewerTypes? | H3: enableUrlRouting? | H3: initializeFoundationCore? | H3: instanceSettings | H3: interfaceConfiguration? | H3: monitoring? | H3: performanceReportOptions | H3: relativity | H3: reviewMode? | H3: signalRTransportMethod | H3: staticContentPath? | H3: testingMode?

- [Interface: IConfigurationService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConfigurationService.htm): Application configuration
  - Second paragraph: readonlyreviewMode: ReviewMode
  - Headings: H1: Interface: IConfigurationService | H2: Extends | H2: Properties | H3: reviewMode | H3: workspaceId | H2: Methods | H3: off() | H3: on() | H3: once() | H3: updateSetting()

- [Interface: IContentChangeApprovedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentChangeApprovedEvent.htm): Event data for the ViewerCollectionEventType.ContentChangeApproved event
  - Second paragraph: currentType: string
  - Headings: H1: Interface: IContentChangeApprovedEvent | H2: Properties | H3: currentType | H3: targetType

- [Interface: IContentChangedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentChangedEvent.htm): Event data for the ViewerCollectionEventType.ContentChanged event
  - Second paragraph: contentType: ContentType
  - Headings: H1: Interface: IContentChangedEvent | H2: Properties | H3: contentType | H3: documentMetric? | H3: item? | H3: reloadRequired? | H3: viewerType?

- [Interface: IContentChangingEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentChangingEvent.htm): Event data for the ViewerCollectionEventType.ContentChanging event
  - Second paragraph: item: IQueueItem
  - Headings: H1: Interface: IContentChangingEvent | H2: Properties | H3: item | H3: viewerType

- [Interface: IContentComparison] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentComparison.htm): Results of the comparison of two content descriptions for use in content highlighting
  - Second paragraph: readonlyisNewProduction: boolean
  - Headings: H1: Interface: IContentComparison | H2: Properties | H3: isNewProduction | H3: isNewProductionType | H3: isNewQueueItem | H3: isNewTextField | H3: isNewTransform | H3: isNewViewerContent | H3: isNewViewerType | H3: isSameContent | H3: result

- [Interface: IContentDescription<QueueItemType, TransformQueueItemType>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentDescriptionQueueItemType__TransformQueueItemType.htm): Metadata describing the content displayed by a specific viewer collection at a given moment in time
  - Second paragraph: • QueueItemTypeextendsIQueueItem = IQueueItem
  - Headings: H1: Interface: IContentDescription<QueueItemType, TransformQueueItemType> | H2: Type Parameters | H2: Properties | H3: item? | H3: type | H3: viewerOptions? | H3: viewerType?

- [Interface: IContentHighlightApiHighlightActiveChangeEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightActiveChangeEvent.htm): Event parameters for the IContentHighlightingApi.onhighlightactivechange event
  - Second paragraph: readonlyhighlights: HighlightMemento[]
  - Headings: H1: Interface: IContentHighlightApiHighlightActiveChangeEvent | H2: Properties | H3: highlights

- [Interface: IContentHighlightApiHighlightAddEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightAddEvent.htm): Event parameters for the IContentHighlightingApi.onhighlightadd event
  - Second paragraph: readonlyhighlights: HighlightMemento[]
  - Headings: H1: Interface: IContentHighlightApiHighlightAddEvent | H2: Properties | H3: highlights | H3: highlightSet

- [Interface: IContentHighlightApiHighlightClickEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightClickEvent.htm): Event parameters for the IContentHighlightingApi.onhighlightclick event
  - Second paragraph: readonlyactive: boolean
  - Headings: H1: Interface: IContentHighlightApiHighlightClickEvent | H2: Properties | H3: active | H3: highlight

- [Interface: IContentHighlightApiHighlightMoveEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightMoveEvent.htm): Event parameters for the IContentHighlightingApi.onhighlightmove event
  - Second paragraph: readonlyhighlight: HighlightMemento
  - Headings: H1: Interface: IContentHighlightApiHighlightMoveEvent | H2: Properties | H3: highlight | H3: highlightSet | H3: oldRange

- [Interface: IContentHighlightApiHighlightRemoveEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightRemoveEvent.htm): Event parameters for the IContentHighlightingApi.onhighlightremove event
  - Second paragraph: readonlyhighlights: HighlightMemento[]
  - Headings: H1: Interface: IContentHighlightApiHighlightRemoveEvent | H2: Properties | H3: highlights | H3: highlightSet

- [Interface: IContentHighlightApiSearchCompleteEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSearchCompleteEvent.htm): Event parameters for the IContentHighlightingApi.onsearchcomplete event
  - Second paragraph: readonlyhighlightSet: HighlightSetMemento
  - Headings: H1: Interface: IContentHighlightApiSearchCompleteEvent | H2: Properties | H3: highlightSet

- [Interface: IContentHighlightApiSearchEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSearchEvent.htm): Event parameters for the IContentHighlightingApi.onsearch event
  - Second paragraph: readonlyhighlightSet: HighlightSetMemento
  - Headings: H1: Interface: IContentHighlightApiSearchEvent | H2: Properties | H3: highlightSet | H3: isFirstTerm | H3: term | H3: termContext?

- [Interface: IContentHighlightApiSetAddEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSetAddEvent.htm): Event parameters for the IContentHighlightingApi.onsetadd event
  - Second paragraph: readonlyhighlightSet: HighlightSetMemento
  - Headings: H1: Interface: IContentHighlightApiSetAddEvent | H2: Properties | H3: highlightSet | H3: isTermHighlightSet | H3: term? | H3: termContext?

- [Interface: IContentHighlightApiSetRemoveEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSetRemoveEvent.htm): Event parameters for the IContentHighlightingApi.onsetremove event
  - Second paragraph: readonlyhighlightSet: HighlightSetMemento
  - Headings: H1: Interface: IContentHighlightApiSetRemoveEvent | H2: Properties | H3: highlightSet

- [Interface: IContentHighlightApiSetVisibleChangeEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSetVisibleChangeEvent.htm): Event parameters for the IContentHighlightingApi.onsetvisiblechange event
  - Second paragraph: readonlyhighlightSet: HighlightSetMemento
  - Headings: H1: Interface: IContentHighlightApiSetVisibleChangeEvent | H2: Properties | H3: highlightSet | H3: visible

- [Interface: IContentHighlightApiVisibleChangeEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiVisibleChangeEvent.htm): Event parameters for the IContentHighlightingApi.onvisiblechange event
  - Second paragraph: readonlyvisible: boolean
  - Headings: H1: Interface: IContentHighlightApiVisibleChangeEvent | H2: Properties | H3: visible

- [Interface: IContentHighlightingApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingApi.htm): API used for managing highlights associated with a specific content highlighting feature on a specific piece of viewer content.
  - Second paragraph: There will be a unique instance of this API for each content highlighting feature on each document loaded into each viewer type.
  - Headings: H1: Interface: IContentHighlightingApi | H2: Extends | H2: Properties | H3: visible | H2: Methods | H3: addHighlight() | H3: addHighlightTooltip() | H3: addTerm() | H3: addTermWithContext() | H3: addToSetGroup() | H3: createSet() | H3: createSetGroup() | H3: deleteSetGroup() | H3: deselectAllAnnotations() | H3: disableAutoHighlight() | H3: doesSetExist() | H3: emit() | H3: enableAutoHighlight() | H3: getHighlights() | H3: getSelectedAnnotations() | H3: getSetGroups() | H3: getSets() | H3: goToFirst() | H3: goToHighlight() | H3: goToLast() | H3: goToNext() | H3: goToPrev() | H3: hide() | H3: highlightTerm() | H3: highlightTermWithContext() | H3: isTermHighlightingInProgress() | H3: off() | H3: offhighlightactivechange() | H3: offhighlightadd() | H3: offhighlightclick() | H3: offhighlightmove() | H3: offhighlightremove() | H3: offsearch() | H3: offsearchcomplete() | H3: offsetadd() | H3: offsetremove() | H3: offsetvisiblechange() | H3: offvisiblechange() | H3: on() | H3: onhighlightactivechange() | H3: onhighlightadd() | H3: onhighlightclick() | H3: onhighlightmove() | H3: onhighlightremove() | H3: onsearch() | H3: onsearchcomplete() | H3: onsetadd() | H3: onsetremove() | H3: onsetvisiblechange() | H3: onvisiblechange() | H3: removeFromSetGroup() | H3: removeHighlight() | H3: removeHighlightSet() | H3: removeHighlightTooltip() | H3: selectAnnotation() | H3: serialize() | H3: setAllHighlightSetsVisibility() | H3: setGroupVisibility() | H3: setHighlightSetVisibility() | H3: setHighlightVisibility() | H3: setVisibility() | H3: show() | H3: toggleHighlightSetVisibility() | H3: toggleHighlightVisibility() | H3: toggleVisibility() | H3: waitForTermHighlightingToComplete()

- [Interface: IContentHighlightingCardApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApi.htm): API for use within content highlighting cards to listen for relevant events and interact with content highlighting
  - Second paragraph: readonlyfeature: IContentHighlightingFeature
  - Headings: H1: Interface: IContentHighlightingCardApi | H2: Properties | H3: feature | H3: supportedViewerTypes | H3: viewerCollection | H3: visible | H2: Methods | H3: getContentDescription() | H3: getHighlightingApi() | H3: getRenderStatus() | H3: hide() | H3: offcontent() | H3: offrender() | H3: offrenderabort() | H3: offrendercomplete() | H3: offrendererror() | H3: offvisiblechange() | H3: oncontent() | H3: onrender() | H3: onrenderabort() | H3: onrendercomplete() | H3: onrendererror() | H3: onvisiblechange() | H3: reload() | H3: setVisible() | H3: show() | H3: toggleVisible()

- [Interface: IContentHighlightingCardApiContentChangeEvent<CType, CTType, PCType, PCTType>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiContentChangeEventCType__CTType__PCType__PCTType.htm): Event indicating that the content displayed by the associated viewer collection has changed
  - Second paragraph: • CTypeextendsIQueueItem = IQueueItem
  - Headings: H1: Interface: IContentHighlightingCardApiContentChangeEvent<CType, CTType, PCType, PCTType> | H2: Type Parameters | H2: Properties | H3: abort? | H3: api | H3: comparison | H3: content | H3: documentMetric | H3: highlightingApi? | H3: previousContent?

- [Interface: IContentHighlightingCardApiRenderAbortEvent<CType, CTType>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderAbortEventCType__CTType.htm): Event indicating that the invocation of the content highlighting feature's render function was aborted
  - Second paragraph: • CTypeextendsIQueueItem = IQueueItem
  - Headings: H1: Interface: IContentHighlightingCardApiRenderAbortEvent<CType, CTType> | H2: Type Parameters | H2: Properties | H3: abort | H3: api | H3: content | H3: highlightingApi? | H3: viewerType

- [Interface: IContentHighlightingCardApiRenderCompleteEvent<CType, CTType>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderCompleteEventCType__CTType.htm): Event indicating that the invocation of the content highlighting feature's render function has completed
  - Second paragraph: • CTypeextendsIQueueItem = IQueueItem
  - Headings: H1: Interface: IContentHighlightingCardApiRenderCompleteEvent<CType, CTType> | H2: Type Parameters | H2: Properties | H3: abort | H3: api | H3: content | H3: highlightingApi? | H3: viewerType

- [Interface: IContentHighlightingCardApiRenderErrorEvent<CType, CTType>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderErrorEventCType__CTType.htm): Event indicating that the invocation of the content highlighting feature's render function failed
  - Second paragraph: • CTypeextendsIQueueItem = IQueueItem
  - Headings: H1: Interface: IContentHighlightingCardApiRenderErrorEvent<CType, CTType> | H2: Type Parameters | H2: Properties | H3: abort | H3: api | H3: content | H3: error | H3: highlightingApi? | H3: viewerType

- [Interface: IContentHighlightingCardApiRenderEvent<CType, CTType>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderEventCType__CTType.htm): Event indicating that the content highlighting feature's render function is being invoked
  - Second paragraph: • CTypeextendsIQueueItem = IQueueItem
  - Headings: H1: Interface: IContentHighlightingCardApiRenderEvent<CType, CTType> | H2: Type Parameters | H2: Properties | H3: abort | H3: api | H3: content | H3: highlightingApi? | H3: viewerType

- [Interface: IContentHighlightingCardApiVisibleChangeEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiVisibleChangeEvent.htm): Event indicating that the visibility of the content highlighting feature has changed
  - Second paragraph: readonlyapi: IReviewInterfaceApi
  - Headings: H1: Interface: IContentHighlightingCardApiVisibleChangeEvent | H2: Properties | H3: api | H3: visible

- [Interface: IContentHighlightingCardVisibleFnParameters<CType, CTType>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardVisibleFnParametersCType__CTType.htm): Parameters passed to content highlighting card visible functions
  - Second paragraph: • CTypeextendsIQueueItem = IQueueItem
  - Headings: H1: Interface: IContentHighlightingCardVisibleFnParameters<CType, CTType> | H2: Type Parameters | H2: Properties | H3: api | H3: content | H3: viewerCollection

- [Interface: IContentHighlightingFeature] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingFeature.htm): Decription of a registered content highlighting feature
  - Second paragraph: readonlyoptionalapplicationGuid: string
  - Headings: H1: Interface: IContentHighlightingFeature | H2: Properties | H3: applicationGuid? | H3: config | H3: extensionId? | H3: id | H3: order | H3: priority

- [Interface: IContentHighlightingFeatureConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingFeatureConfig.htm): Content highlighting feature configuration parameters
  - Second paragraph: optionalcardId: string
  - Headings: H1: Interface: IContentHighlightingFeatureConfig | H2: Properties | H3: cardId? | H3: cardVisibleFn? | H3: enabled? | H3: id | H3: name | H3: order? | H3: renderFn | H3: supportedViewerTypes? | H3: visibleByDefault?

- [Interface: IContentHighlightingManager] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingManager.htm): API for interacting with the content highlighting features for a given viewer collection.
  - Second paragraph: Each viewer collection will have its own instance of this manager.
  - Headings: H1: Interface: IContentHighlightingManager | H2: Properties | H3: initialized | H3: viewerCollection | H2: Methods | H3: getCard() | H3: getCardApi() | H3: getFeatureVisible() | H3: getHighlightingApi() | H3: getRenderStatus() | H3: hideFeature() | H3: reload() | H3: setFeatureVisible() | H3: showFeature() | H3: toggleFeatureVisible()

- [Interface: IContentHighlightingRenderStatus] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingRenderStatus.htm): readonlyoptionalerror: Error
  - Second paragraph: readonlystatus: RenderStatus
  - Headings: H1: Interface: IContentHighlightingRenderStatus | H2: Properties | H3: error? | H3: status

- [Interface: IContentHighlightingService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingService.htm): Content Highlighting Framework API for interacting with high-level content highlighting features
  - Second paragraph: readonlyenabled: boolean
  - Headings: H1: Interface: IContentHighlightingService | H2: Properties | H3: enabled | H3: features | H2: Methods | H3: disable() | H3: disableFeature() | H3: enable() | H3: enableFeature() | H3: getFeature() | H3: getFeatureEnabled() | H3: offenabledchange() | H3: offfeatureenabledchange() | H3: offfeatureregistered() | H3: onenabledchange() | H3: onfeatureenabledchange() | H3: onfeatureregistered() | H3: setEnabled() | H3: setFeatureEnabled() | H3: toggleEnabled() | H3: toggleFeatureEnabled()

- [Interface: IContentHighlightingServiceEnabledChangeEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingServiceEnabledChangeEvent.htm): Event indicating that the Content Highlighting Framework has been enabled or disabled
  - Second paragraph: readonlyenabled: boolean
  - Headings: H1: Interface: IContentHighlightingServiceEnabledChangeEvent | H2: Properties | H3: enabled

- [Interface: IContentHighlightingServiceFeatureEnabledChangeEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingServiceFeatureEnabledChangeEvent.htm): Event indicating that a content highlighting feature has been enabled or disabled
  - Second paragraph: readonlyenabled: boolean
  - Headings: H1: Interface: IContentHighlightingServiceFeatureEnabledChangeEvent | H2: Properties | H3: enabled | H3: feature

- [Interface: IContentHighlightingServiceFeatureRegisteredEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingServiceFeatureRegisteredEvent.htm): Event indicating that a new content highlighting feature has been registered
  - Second paragraph: readonlyfeature: IContentHighlightingFeature
  - Headings: H1: Interface: IContentHighlightingServiceFeatureRegisteredEvent | H2: Properties | H3: feature

- [Interface: IContext] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContext.htm): Context data that can be attached globally to all IReports or to individual IWorkflow reports
  - Second paragraph: [key: string]: ApmCustomData
  - Headings: H1: Interface: IContext | H2: Indexable

- [Interface: IContextMenu] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenu.htm): Context Menu that allows modification of the menu IContextMenuItems and whether it is active
  - Second paragraph: readonlyenabled: boolean
  - Headings: H1: Interface: IContextMenu | H2: Properties | H3: enabled | H3: parentElementId | H2: Methods | H3: addItem() | H3: addItemConfig() | H3: disable() | H3: enable() | H3: getItem() | H3: itemExists() | H3: items() | H3: removeAll() | H3: removeItem()

- [Interface: IContextMenuFactory] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuFactory.htm): Entity used to create right click IContextMenus on HTMLElements
  - Second paragraph: createContextMenu(parentElement, menuItems, viewerCollection, onBuildReviewData?, applicationWindow?): IContextMenu
  - Headings: H1: Interface: IContextMenuFactory | H2: Methods | H3: createContextMenu() | H3: createContextMenuById() | H3: createContextMenuItem() | H3: createContextMenuItemFromConfig() | H3: getContextMenu() | H3: getContextMenuById() | H3: removeContextMenu() | H3: removeContextMenuById()

- [Interface: IContextMenuItem] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuItem.htm): The options for a item in a Context Menu. It encapsulates the jquery-context-menu option.
  - Second paragraph: childItems: IContextMenuItem[]
  - Headings: H1: Interface: IContextMenuItem | H2: Properties | H3: childItems | H3: disabled | H3: icon | H3: onBuildCallback() | H3: onClickCallback() | H3: order | H3: permissionCheck? | H3: rwcIcon? | H3: rwcIconClass? | H3: rwcIconColor? | H3: text | H3: visible | H2: Methods | H3: deepCopy() | H3: getOptions()

- [Interface: IContextMenuItemConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuItemConfig.htm): The options for a item in a Context Menu. It encapsulates the jquery-context-menu option.
  - Second paragraph: optionalchildItems: IContextMenuItemConfig[]
  - Headings: H1: Interface: IContextMenuItemConfig | H2: Properties | H3: childItems? | H3: disabled? | H3: icon? | H3: onBuildCallback()? | H3: onClickCallback()? | H3: order? | H3: permissionCheck? | H3: rwcIcon? | H3: rwcIconClass? | H3: rwcIconColor? | H3: text | H3: visible?

- [Interface: IContextMenuNativeFileData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuNativeFileData.htm): Data about the queue item native
  - Second paragraph: fileTypeId: number
  - Headings: H1: Interface: IContextMenuNativeFileData | H2: Properties | H3: fileTypeId | H3: relativityNativeType

- [Interface: IContextMenuQueueItemData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuQueueItemData.htm): Data about the queue item being interacted with
  - Second paragraph: optionalitem: IQueueItem
  - Headings: H1: Interface: IContextMenuQueueItemData | H2: Properties | H3: item? | H3: nativeData?

- [Interface: IContextMenuReviewData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuReviewData.htm): Information provided to IContextMenuItems about the document being interacted with
  - Second paragraph: cursor: Cursor
  - Headings: H1: Interface: IContextMenuReviewData | H2: Properties | H3: cursor | H3: queueItemData? | H3: queuePointer | H3: workspaceId | H2: Methods | H3: exists() | H3: get() | H3: getAnnotationsAtCursor() | H3: getSelectedAnnotations() | H3: getSelectedText() | H3: getSelection() | H3: getViewerObjectsAtCursor() | H3: set()

- [Interface: IControlCollection] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IControlCollection.htm): A dynamic toolbar control to group and organize related controls
  - Second paragraph: optionalariaLabel: string
  - Headings: H1: Interface: IControlCollection | H2: Extends | H2: Extended by | H2: Properties | H3: ariaLabel? | H3: class | H3: controls | H3: disabled | H3: id | H3: isControlCollection | H3: isFlexible | H3: isHidden | H3: leftDivider | H3: order | H3: permissionCheck? | H3: rightDivider | H3: role? | H3: scrollDimensions | H3: title | H3: viewModelPath | H2: Methods | H3: addControl() | H3: disable() | H3: enable() | H3: getControlById() | H3: hide() | H3: removeControl() | H3: show()

- [Interface: IConvenienceApiService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConvenienceApiService.htm): Provides access to the Relativity Forms Convenience API for the active coding card.
  - Second paragraph: get(): IRelativityFormsConvenienceAPI
  - Headings: H1: Interface: IConvenienceApiService | H2: Methods | H3: get()

- [Interface: ICreateAnnotationOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICreateAnnotationOptions.htm): Annotation creation options
  - Second paragraph: optionalpersist: boolean
  - Headings: H1: Interface: ICreateAnnotationOptions | H2: Properties | H3: persist? | H3: text? | H3: textSize?

- [Interface: ICreateDocumentActionOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICreateDocumentActionOptions.htm): optionalsectionIcon: string
  - Second paragraph: (Optional) The icon to display for a document action section
  - Headings: H1: Interface: ICreateDocumentActionOptions | H2: Properties | H3: sectionIcon?

- [Interface: ICustomAnnotationData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomAnnotationData.htm): Custom IAnnotation styles
  - Second paragraph: optionalborderColor: IColor
  - Headings: H1: Interface: ICustomAnnotationData | H2: Properties | H3: borderColor? | H3: borderSize? | H3: borderStyle? | H3: fillColor?

- [Interface: ICustomCardLoader] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomCardLoader.htm): Configuration for custom cards that can't use the viewmodel or iframe configuration
  - Second paragraph: loadCard: (card, target) => Promise<void>
  - Headings: H1: Interface: ICustomCardLoader | H2: Properties | H3: loadCard() | H3: unloadCard()

- [Interface: ICustomControl] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomControl.htm): Custom Toolbar Control for creating a custom toolbar control
  - Second paragraph: optionalariaLabel: string
  - Headings: H1: Interface: ICustomControl | H2: Extends | H2: Properties | H3: ariaLabel? | H3: class | H3: disabled | H3: id | H3: innerHTML | H3: isControlCollection | H3: isFlexible | H3: isHidden | H3: order | H3: permissionCheck? | H3: role? | H3: scrollDimensions | H3: title | H3: viewModelPath | H2: Methods | H3: disable() | H3: enable() | H3: hide() | H3: show()

- [Interface: ICustomData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomData.htm): [key: string]: CustomData
  - Headings: H1: Interface: ICustomData | H2: Indexable

- [Interface: ICustomStatusPillConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomStatusPillConfig.htm): Definition for a custom status pill to be displayed
  - Second paragraph: optionalerrorMessage: string
  - Headings: H1: Interface: ICustomStatusPillConfig | H2: Properties | H3: errorMessage? | H3: inProgressMessage? | H3: name | H3: successMessage?

- [Interface: IDeleteCollectionRequestEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDeleteCollectionRequestEvent.htm): Event data for ViewerServiceEventType.DeleteCollectionRequest event
  - Second paragraph: collection: IViewerCollection
  - Headings: H1: Interface: IDeleteCollectionRequestEvent | H2: Properties | H3: collection

- [Interface: IDeleteQueueRequestEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDeleteQueueRequestEvent.htm): Event data for the QueueServiceEventType.DeleteQueueRequest event
  - Second paragraph: queue: IQueue
  - Headings: H1: Interface: IDeleteQueueRequestEvent | H2: Properties | H3: queue

- [Interface: IDocumentActionCollection] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentActionCollection.htm): Document-level actions available at the top of the document viewer
  - Second paragraph: addDocumentAction(docAction, section, subsection): any
  - Headings: H1: Interface: IDocumentActionCollection | H2: Methods | H3: addDocumentAction() | H3: createDocumentAction() | H3: disable() | H3: enable() | H3: getDocumentAction() | H3: removeDocumentAction()

- [Interface: IDocumentActionControl] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentActionControl.htm): Base Type for a toolbar control that can be added to an IToolbar
  - Second paragraph: optionalariaLabel: string
  - Headings: H1: Interface: IDocumentActionControl | H2: Extends | H2: Properties | H3: ariaLabel? | H3: class | H3: disabled | H3: documentActionCollection | H3: id | H3: isControlCollection | H3: isFlexible | H3: isHidden | H3: order | H3: permissionCheck? | H3: role? | H3: scrollDimensions | H3: title | H3: viewModelPath | H2: Methods | H3: disable() | H3: enable() | H3: handleAction() | H3: handleVCUpdate() | H3: hide() | H3: show() | H3: updateVisible()

- [Interface: IDocumentDataCacheManager] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentDataCacheManager.htm): Entity for managing the document data cache
  - Second paragraph: tryClearCache(documentArtifactId, productionArtifactId?, longTextArtifactId?): boolean
  - Headings: H1: Interface: IDocumentDataCacheManager | H2: Methods | H3: tryClearCache() | H3: tryClearCacheForQueueItem()

- [Interface: IDocumentHistoryService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentHistoryService.htm): Class for working with Document History
  - Second paragraph: getDocumentHistory(documentId, refreshCache?, startIndex?, pageSize?, rowCondition?, sorts?, auditQueryOptions?): Promise<IAuditObjectManagerData>
  - Headings: H1: Interface: IDocumentHistoryService | H2: Methods | H3: getDocumentHistory() | H3: getDocumentHistorySlim()

- [Interface: IDocumentItem] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentItem.htm): Document Queue Item
  - Second paragraph: readonlyartifactId: number
  - Headings: H1: Interface: IDocumentItem | H2: Extends | H2: Properties | H3: artifactId | H3: extension | H3: id | H3: itemIdentifier | H3: itemTransforms? | H3: label | H3: type

- [Interface: IDocumentItemIdentifier] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentItemIdentifier.htm): Item that can be used to identify a IDocumentItem
  - Second paragraph: readonlyartifactId: number
  - Headings: H1: Interface: IDocumentItemIdentifier | H2: Extends | H2: Properties | H3: artifactId | H3: id?

- [Interface: IDocumentListCardService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentListCardService.htm): Class for interacting with the document list card
  - Second paragraph: setView(viewArtifactId): Promise<void>
  - Headings: H1: Interface: IDocumentListCardService | H2: Methods | H3: setView()

- [Interface: IDocumentObjectManagerData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentObjectManagerData.htm): CurrentStartIndex: number
  - Second paragraph: optionalFields: IFieldsEntity[]
  - Headings: H1: Interface: IDocumentObjectManagerData | H2: Properties | H3: CurrentStartIndex | H3: Fields? | H3: Objects? | H3: ObjectType | H3: ResultCount | H3: TotalCount

- [Interface: IEmbeddedFeatureConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IEmbeddedFeatureConfig.htm): [featureName: string]: FeatureConfigValue
  - Second paragraph: optionalcontextMenu: boolean
  - Headings: H1: Interface: IEmbeddedFeatureConfig | H2: Indexable | H2: Properties | H3: contextMenu? | H3: extensions? | H3: httpWarningBanner? | H3: oi.viewer.searchPill? | H3: previewApi?

- [Interface: IErrorDisplayOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IErrorDisplayOptions.htm): Options used to display a full screen error on top of an HTMLElement
  - Second paragraph: optionalbackgroundColor: string
  - Headings: H1: Interface: IErrorDisplayOptions | H2: Properties | H3: backgroundColor? | H3: imageFileName? | H3: linkInformation? | H3: parentElement? | H3: parentElementId? | H3: retryHandler()?

- [Interface: IErrorLinkInformation] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IErrorLinkInformation.htm): Options for displaying a link as part of a full screen error
  - Second paragraph: link: string
  - Headings: H1: Interface: IErrorLinkInformation | H2: Properties | H3: link | H3: onclick()? | H3: target | H3: text

- [Interface: IErrorService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IErrorService.htm): Error Service, used to display full screen errors on an HTMLElement
  - Second paragraph: cleanupFullScreenError(parentElement?): void
  - Headings: H1: Interface: IErrorService | H2: Methods | H3: cleanupFullScreenError() | H3: cleanupFullScreenErrorById() | H3: cleanupHangingFullScreenErrors() | H3: displayConfigurableFullScreenError() | H3: displayFullScreenError() | H3: displayFullScreenErrorById()

- [Interface: IEventEmitter<T>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IEventEmitterT.htm): Entity that raises events that can be subscribed to
  - Second paragraph: type
  - Headings: H1: Interface: IEventEmitter<T> | H2: Type Param | H2: Extended by | H2: Type Parameters | H2: Methods | H3: off() | H3: on() | H3: once()

- [Interface: IExpirationCache<T>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExpirationCacheT.htm): • T
  - Second paragraph: Cache item type
  - Headings: H1: Interface: IExpirationCache<T> | H2: Type Parameters | H2: Methods | H3: addOrUpdate() | H3: get() | H3: has() | H3: howOld() | H3: tryRemove() | H3: updateMaxSize()

- [Interface: IExtendsConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtendsConfig.htm): Configuration object for the extends property on ICardConfig for the custom outside in viewer
  - Second paragraph: optionaloptions: CustomOutsideInViewerOptions
  - Headings: H1: Interface: IExtendsConfig | H2: Properties | H3: options? | H3: type

- [Interface: IExtension] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtension.htm): Information about a registered Relativity Review extension
  - Second paragraph: readonlyapplicationGuid: string
  - Headings: H1: Interface: IExtension | H2: Properties | H3: applicationGuid | H3: applicationName | H3: config | H3: error? | H3: fileName | H3: metrics | H3: status | H3: version

- [Interface: IExtensionApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionApi.htm): API for interacting with Relativity Review IExtensions
  - Second paragraph: readonlyall: IExtensionCollection
  - Headings: H1: Interface: IExtensionApi | H2: Properties | H3: all | H3: debug | H3: enabled | H2: Methods | H3: getById()

- [Interface: IExtensionApplication] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionApplication.htm): appName: string
  - Second paragraph: extensions: IExtension[]
  - Headings: H1: Interface: IExtensionApplication | H2: Properties | H3: appName | H3: extensions | H3: guid | H3: name

- [Interface: IExtensionCollection] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionCollection.htm): Collection of IExtensions organized by application GUID
  - Second paragraph: [applicationGuid: string]: object
  - Headings: H1: Interface: IExtensionCollection | H2: Indexable

- [Interface: IExtensionComponent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionComponent.htm): Class for working with Viewer Settings Card and holding the setting notw information
  - Second paragraph: optionalclass: string
  - Headings: H1: Interface: IExtensionComponent | H2: Properties | H3: class? | H3: id | H3: previous? | H3: text?

- [Interface: IExtensionConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionConfig_1.htm): Defines a Relativity Review extension and its behavior
  - Second paragraph: readonlyoptionalcards: ICardConfig[]
  - Headings: H1: Interface: IExtensionConfig | H2: Properties | H3: cards? | H3: contentHighlighting? | H3: id | H3: isEnabled()? | H3: itemListFieldValueTransforms? | H3: itemLoadTransforms? | H3: lifecycle? | H3: name | H3: rtcMessageHandlers? | H3: smartHighlights? | H3: viewerCollectionFooterControls()? | H3: viewerContextMenus()? | H3: viewers? | H3: viewerToolbarControls()?

- [Interface: IExtensionConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionConfig.htm): Defines a Relativity Review extension and its behavior
  - Second paragraph: readonlyoptionalcards: ICardConfig[]
  - Headings: H1: Interface: IExtensionConfig | H2: Properties | H3: cards? | H3: contentHighlighting? | H3: id | H3: isEnabled()? | H3: itemListFieldValueTransforms? | H3: itemLoadTransforms? | H3: lifecycle? | H3: name | H3: rtcMessageHandlers? | H3: smartHighlights? | H3: viewerCollectionFooterControls()? | H3: viewerContextMenus()? | H3: viewers? | H3: viewerToolbarControls()?

- [Interface: IExtensionConfigurationSettings] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionConfigurationSettings.htm): Configuration passed on the parameters object to extension scripts registered as application resource files
  - Second paragraph: readonlyreviewMode: ReviewMode
  - Headings: H1: Interface: IExtensionConfigurationSettings | H2: Properties | H3: reviewMode | H3: workspaceId

- [Interface: IExtensionDebugApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionDebugApi.htm): API for debugging Relativity Review IExtensions
  - Second paragraph: disableById(id): void
  - Headings: H1: Interface: IExtensionDebugApi | H2: Methods | H3: disableById() | H3: disableExtensionFramework() | H3: enableAll() | H3: enableById() | H3: enableExtensionFramework()

- [Interface: IExtensionDetails] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionDetails_1.htm): readonlysource: IExtensionSource
  - Second paragraph: The source of the extension
  - Headings: H1: Interface: IExtensionDetails | H2: Properties | H3: source

- [Interface: IExtensionDetails] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionDetails.htm): readonlysource: IExtensionSource
  - Second paragraph: The source of the extension
  - Headings: H1: Interface: IExtensionDetails | H2: Properties | H3: source

- [Interface: IExtensionFeatureOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionFeatureOptions.htm): Options for the extensions feature in embedded mode.
  - Second paragraph: optionalfilter: (extension) => boolean
  - Headings: H1: Interface: IExtensionFeatureOptions | H2: Properties | H3: filter()?

- [Interface: IExtensionFilterDetails] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionFilterDetails.htm): Filter details passed to the extension filter function in embedded mode.
  - Second paragraph: optionalapplicationGuid: string
  - Headings: H1: Interface: IExtensionFilterDetails | H2: Properties | H3: applicationGuid? | H3: extensionId?

- [Interface: IExtensionLifecycle] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionLifecycle.htm): Application-level lifecycle events that an extension can subscribe to
  - Second paragraph: optionalactivated: (api) => void | Promise<void>
  - Headings: H1: Interface: IExtensionLifecycle | H2: Properties | H3: activated()? | H3: apiready()? | H3: canDeactivate()? | H3: canTeardown()? | H3: deactivated()? | H3: ready()? | H3: teardown()?

- [Interface: IExtensionMetrics] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionMetrics.htm): Collection of metrics related to a specific IExtension
  - Second paragraph: [metricName: string]: number | string | boolean
  - Headings: H1: Interface: IExtensionMetrics | H2: Indexable

- [Interface: IExtensionParameters] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionParameters.htm): Parameters passed to extension scripts registered as application resource files
  - Second paragraph: readonlyapplicationContext: ApplicationContext
  - Headings: H1: Interface: IExtensionParameters | H2: Properties | H3: applicationContext | H3: configuration | H3: embeddedContextKey? | H3: extensionDetails | H3: foundationInstance? | H3: getResourceFileUrl() | H3: getResourceUrl() | H3: relativityTenantContext | H3: version

- [Interface: IFeaturesInitializedEventData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFeaturesInitializedEventData.htm): Event data for the RelativityViewerEventType.FeaturesInitialized event
  - Second paragraph: viewerType: string
  - Headings: H1: Interface: IFeaturesInitializedEventData | H2: Properties | H3: viewerType

- [Interface: IFieldIdentifier] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFieldIdentifier.htm): optionalArtifactId: number
  - Second paragraph: optionalGuid: string
  - Headings: H1: Interface: IFieldIdentifier | H2: Properties | H3: ArtifactId? | H3: Guid? | H3: Name?

- [Interface: IFieldsEntity] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFieldsEntity.htm): ArtifactID: number
  - Second paragraph: FieldCategory: string
  - Headings: H1: Interface: IFieldsEntity | H2: Properties | H3: ArtifactID | H3: FieldCategory | H3: FieldType | H3: Guids? | H3: Name | H3: ViewFieldID

- [Interface: IFieldValuesEntity] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFieldValuesEntity.htm): Field: IFieldsEntity
  - Second paragraph: Value: string | IFieldIdentifier
  - Headings: H1: Interface: IFieldValuesEntity | H2: Properties | H3: Field | H3: Value

- [Interface: IFileService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFileService.htm): Class for interacting with the underlying files that are displayed in the viewer
  - Second paragraph: readonlyimaging: IImagingService
  - Headings: H1: Interface: IFileService | H2: Properties | H3: imaging | H3: native

- [Interface: IFilterGroup] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFilterGroup.htm): Object used to display Filter Groups in the UI
  - Second paragraph: readonlyfilterType: FilterType
  - Headings: H1: Interface: IFilterGroup | H2: Properties | H3: filterType | H3: groupName | H3: isDate | H3: isDateTime | H3: isTime | H3: order | H2: Methods | H3: deepCopy()

- [Interface: IFilterOption] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFilterOption.htm): Object used to display Filter Options in the UI
  - Second paragraph: active: boolean
  - Headings: H1: Interface: IFilterOption | H2: Properties | H3: active | H3: filterType | H3: id | H3: locked | H3: messageCount | H3: option | H2: Methods | H3: deepCopy()

- [Interface: IFiltersUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFiltersUpdatedEvent.htm): Event data for the RelativityViewerEventType.FiltersUpdated event
  - Second paragraph: filterGroups: IFilterGroup[]
  - Headings: H1: Interface: IFiltersUpdatedEvent | H2: Properties | H3: filterGroups

- [Interface: IHeaders] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHeaders.htm): add(key, value): void
  - Second paragraph: • key: string
  - Headings: H1: Interface: IHeaders | H2: Methods | H3: add() | H3: clear() | H3: get() | H3: has()

- [Interface: IHighlightListenerActive()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightListenerActive__.htm): The arguments to this event listener are as follows:
  - Second paragraph: IHighlightListenerActive(highlights, refObject?, ...args?): void
  - Headings: H1: Interface: IHighlightListenerActive() | H2: Parameters | H2: Returns

- [Interface: IHighlightListenerClick()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightListenerClick__.htm): The arguments to this event listener are as follows:
  - Second paragraph: IHighlightListenerClick(highlight, isActive, refObject?, ...args?): void
  - Headings: H1: Interface: IHighlightListenerClick() | H2: Parameters | H2: Returns

- [Interface: IHighlightListenerVisibility()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightListenerVisibility__.htm): The arguments to this event listener are as follows:
  - Second paragraph: IHighlightListenerVisibility(highlightSet, visible, refObject?, ...args?): void
  - Headings: H1: Interface: IHighlightListenerVisibility() | H2: Parameters | H2: Returns

- [Interface: IHighlightService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightService.htm): Class for working with IPersistentHighlightSets and IPersistentHighlightTerms
  - Second paragraph: addTerms(setId, terms, syntax?): void
  - Headings: H1: Interface: IHighlightService | H2: Methods | H3: addTerms() | H3: clearNewHighlightStyling() | H3: clearRecentSearchTerm() | H3: clearRecentSearchTerms() | H3: getAllHighlightData() | H3: getPersistentHighlightSetData() | H3: getRecentSearchSetData() | H3: setActiveViewer() | H3: setRecentSearchTerm()

- [Interface: IHighlightSetListenerAdd()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerAdd__.htm): The arguments to this event listener are as follows:
  - Second paragraph: IHighlightSetListenerAdd(highlightSet, highlights, refObject?, ...args?): void
  - Headings: H1: Interface: IHighlightSetListenerAdd() | H2: Parameters | H2: Returns

- [Interface: IHighlightSetListenerDone()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerDone__.htm): The arguments to this event listener are as follows:
  - Second paragraph: IHighlightSetListenerDone(highlightSet, refObject?, ...args?): void
  - Headings: H1: Interface: IHighlightSetListenerDone() | H2: Parameters | H2: Returns

- [Interface: IHighlightSetListenerMove()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerMove__.htm): The arguments to this event listener are as follows:
  - Second paragraph: For now, we need to expose the raw range object to maintain backwards compatibility and not break existing callers of this method. In the future, this will be downgraded to a memento object
  - Headings: H1: Interface: IHighlightSetListenerMove() | H2: Parameters | H2: Returns

- [Interface: IHighlightSetListenerRemove()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerRemove__.htm): The arguments to this event listener are as follows:
  - Second paragraph: IHighlightSetListenerRemove(highlightSet, highlights, refObject?, ...args?): void
  - Headings: H1: Interface: IHighlightSetListenerRemove() | H2: Parameters | H2: Returns

- [Interface: IHighlightViewer] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightViewer.htm): Persistent Highlight API for IViewerCardInstances
  - Second paragraph: readonlyhighlights: IViewerHighlightManager
  - Headings: H1: Interface: IHighlightViewer | H2: Extends | H2: Extended by | H2: Properties | H3: highlights | H3: shouldHighlight | H2: Methods | H3: off() | H3: on() | H3: once()

- [Interface: IHtmlCardBanner] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHtmlCardBanner.htm): Custom HTML card banner
  - Second paragraph: bannerClass: string
  - Headings: H1: Interface: IHtmlCardBanner | H2: Extends | H2: Properties | H3: bannerClass | H3: card | H3: dismissed | H3: element? | H3: type | H2: Methods | H3: dismiss() | H3: onRender()

- [Interface: IHtmlCardBannerConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHtmlCardBannerConfig.htm): Configuration for an HTML card banner
  - Second paragraph: optionalbannerClass: string
  - Headings: H1: Interface: IHtmlCardBannerConfig | H2: Extends | H2: Properties | H3: bannerClass? | H3: onrender()?

- [Interface: IHttpClient] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHttpClient.htm): get(url, params?, traditional?): Promise<IHttpResponseMessage>
  - Second paragraph: • url: string
  - Headings: H1: Interface: IHttpClient | H2: Methods | H3: get() | H3: post() | H3: put()

- [Interface: IHttpResponseMessage] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHttpResponseMessage.htm): content: any
  - Second paragraph: Gets the content of the response.
  - Headings: H1: Interface: IHttpResponseMessage | H2: Properties | H3: content | H3: headers | H3: isSuccess | H3: mimeType | H3: requestMessage | H3: response | H3: responseType | H3: reviver() | H3: statusCode | H3: statusText

- [Interface: IHyperlink] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHyperlink.htm): readonlyoptionalalt: string
  - Second paragraph: The alternate text for the hyperlink
  - Headings: H1: Interface: IHyperlink | H2: Properties | H3: alt? | H3: artifactId? | H3: external | H3: id | H3: manuallyAdded | H3: name? | H3: range? | H3: target? | H3: type | H3: url | H3: userData

- [Interface: IHyperlinkManagerApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHyperlinkManagerApi.htm): Partial IHyperlinkManager interface that defines the hyperlink API methods
  - Second paragraph: activate(hyperlink): boolean
  - Headings: H1: Interface: IHyperlinkManagerApi | H2: Remarks | H2: Methods | H3: activate() | H3: add() | H3: forPage() | H3: forRange() | H3: remove()

- [Interface: IHyperlinkManagerEventApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHyperlinkManagerEventApi.htm): Partial IHyperlinkManager interface that defines the event handler API methods
  - Second paragraph: offactivate(activateCallback, refObject?): void
  - Headings: H1: Interface: IHyperlinkManagerEventApi | H2: Remarks | H2: Methods | H3: offactivate() | H3: onactivate() | H3: onactivateonce()

- [Interface: IIframeCardLoader] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IIframeCardLoader.htm): Configuration for iframe cards
  - Second paragraph: optionalautoResolveLoad: boolean
  - Headings: H1: Interface: IIframeCardLoader | H2: Properties | H3: autoResolveLoad? | H3: fileName? | H3: url?

- [Interface: IImageButtonControl] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImageButtonControl.htm): Image Button Toolbar Control for creating an Image Button bound to a click event delegate
  - Second paragraph: optionalariaLabel: string
  - Headings: H1: Interface: IImageButtonControl | H2: Extends | H2: Properties | H3: ariaLabel? | H3: class | H3: disabled | H3: id | H3: isControlCollection | H3: isFlexible | H3: isHidden | H3: onClick() | H3: order | H3: permissionCheck? | H3: role? | H3: scrollDimensions | H3: src | H3: title | H3: viewModelPath | H2: Methods | H3: disable() | H3: enable() | H3: hide() | H3: show()

- [Interface: IImageViewer] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImageViewer.htm): Image Viewer IViewerCardInstance
  - Second paragraph: readonlyoptionalactiveMarkupSetArtifactId: number
  - Headings: H1: Interface: IImageViewer | H2: Extends | H2: Properties | H3: activeMarkupSetArtifactId? | H3: annotationCount | H3: annotationToolMode? | H3: annotationToolSubType? | H3: annotationToolType? | H3: cardActivated()? | H3: cardBuildTabOptions()? | H3: cardBuildToolbarOptions()? | H3: cardCanDeactivate()? | H3: cardCreateUnsupportedOverlayCard()? | H3: cardDeactivated()? | H3: cardError()? | H3: cardLoaded()? | H3: cardLoadState()? | H3: cardMaximized()? | H3: cardResized()? | H3: cardRestored()? | H3: cardSaveState()? | H3: cardUnloaded()? | H3: contextualSearchView | H3: currentPageIndex | H3: currentPageName | H3: designationRendering | H3: drawingToolType | H3: enableUnitization | H3: enableUnitizationRedesign | H3: hasWaveform | H3: highlightsEnabled | H3: id | H3: loadError | H3: loadSuccessful | H3: markupVisibility | H3: oiPagesLoadedCount | H3: persistedHighlightColor | H3: persistedRedactionMode | H3: persistedRedactionType | H3: redactionsEnabled | H3: redactionText | H3: redactionTextSize | H3: showWaveformView | H3: thumbnailView | H3: timelineView | H3: totalImageCount | H3: transcriptDesignationRendering | H3: transcriptView | H3: transientHighlight | H3: type | H3: unsupportedTabTitle? | H2: Methods | H3: cardLoadItem() | H3: checkHasFeature() | H3: createAnnotation() | H3: createCellRange() | H3: createFullPageRedaction() | H3: createRectRange() | H3: createTextRange() | H3: deleteAllAnnotations() | H3: deleteAnnotation() | H3: deleteAnnotations() | H3: deleteAnnotationType() | H3: deselectAllAnnotations() | H3: getAquaView() | H3: getExternalContent() | H3: getFeatureManager() | H3: getHiddenContentStatus() | H3: getObjectsAtPosition() | H3: getObjectsAtTranscriptPosition() | H3: getPageHeight() | H3: getPageRotation() | H3: getPageWidth() | H3: getSelectedAnnotations() | H3: getSelectionMode() | H3: hasFeature() | H3: hasPaging() | H3: hideRedactions() | H3: massCreateAnnotation() | H3: massDeleteAnnotationType() | H3: moveToNextPage() | H3: moveToPage() | H3: moveToPreviousPage() | H3: openAboutModal() | H3: openConfirmDeleteImagesModal() | H3: openCreateMassRedactionModal() | H3: openDocumentUnitizationModal() | H3: openEditTextRedactionModal() | H3: openMassDeleteMarkupModal() | H3: openSaveAsPdfModal() | H3: openSingleFileUploadModal() | H3: persistHighlightColor() | H3: persistRedactionMode() | H3: persistRedactionType() | H3: reloadAnnotations() | H3: rotateAllPagesClockwise() | H3: rotateCurrentPageClockwise() | H3: selectAllAnnotations() | H3: selectAnnotation() | H3: selectCellRange() | H3: selectionRange() | H3: selectRectRange() | H3: selectTextRange() | H3: setActiveMarkupSet() | H3: setDesignationRendering() | H3: setDrawingTool() | H3: setExternalContent() | H3: setPageLayoutMode() | H3: setPageRotation() | H3: setPageRotationAllImages() | H3: setSelectionMode() | H3: setTranscriptDesignationRendering() | H3: showBanner() | H3: showHiddenContent() | H3: showRedactions() | H3: toggleFilterDrawer() | H3: toggleRedactionOpacity() | H3: toggleThumbnails() | H3: totalPageCount() | H3: transparentRedactions() | H3: updateAnnotation() | H3: updateAnnotations() | H3: zoomIn() | H3: zoomOut() | H3: zoomToFit() | H3: zoomToIndex()

- [Interface: IImagingCompletedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImagingCompletedEvent.htm): Event data for the ImagingServiceEventType.ImagingCompleted event
  - Second paragraph: hasImages: boolean
  - Headings: H1: Interface: IImagingCompletedEvent | H2: Properties | H3: hasImages

- [Interface: IImagingProfileInfo] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImagingProfileInfo.htm): ArtifactID: number
  - Second paragraph: Artifact ID of the profile
  - Headings: H1: Interface: IImagingProfileInfo | H2: Properties | H3: ArtifactID | H3: ProfileName | H3: RestrictedNativeTypes?

- [Interface: IImagingService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImagingService.htm): Class for creating and deleting images
  - Second paragraph: canAddImage(profileId?): boolean
  - Headings: H1: Interface: IImagingService | H2: Extends | H2: Methods | H3: canAddImage() | H3: canCreateImage() | H3: canDeleteImages() | H3: canReplaceImage() | H3: createImage() | H3: deleteImages() | H3: getImagingProfilesForUser() | H3: newImageAdded() | H3: off() | H3: on() | H3: once()

- [Interface: IInstanceSettings] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IInstanceSettings.htm): Relativity Instance Settings that can be overridden
  - Second paragraph: optionalnumberOfDocumentsToPrepareAhead: number
  - Headings: H1: Interface: IInstanceSettings | H2: Properties | H3: numberOfDocumentsToPrepareAhead?

- [Interface: IInternalApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IInternalApi.htm): readonlyoptionalqueuePointer: IQueuePointer
  - Second paragraph: Gets the internal queue pointer used for preloading, can be used to get the queue
  - Headings: H1: Interface: IInternalApi | H2: Properties | H3: queuePointer? | H2: Methods | H3: loadQueuePointer() | H3: prepareQueue()

- [Interface: IItemListFieldValueTransform] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemListFieldValueTransform.htm): retrieveFieldArtifactIds: ItemListFieldValueTransformIdentificationFn
  - Second paragraph: The function used to retrieve the list of field artifact IDs that should apply this transform
  - Headings: H1: Interface: IItemListFieldValueTransform | H2: Properties | H3: retrieveFieldArtifactIds | H3: transformFn

- [Interface: IItemLoadTransform] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemLoadTransform.htm): Defines the configuration for an item load transform on a given viewer type
  - Second paragraph: conflictBehavior: ComponentConflictBehavior
  - Headings: H1: Interface: IItemLoadTransform | H2: Properties | H3: conflictBehavior | H3: transformFn | H3: viewerType

- [Interface: IItemLoadTransformResult] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemLoadTransformResult.htm): The result of an item load transform that describes the parameters which will be passed to the viewer card instance's cardLoadItem() method
  - Second paragraph: item: IQueueItem
  - Headings: H1: Interface: IItemLoadTransformResult | H2: Properties | H3: item | H3: options

- [Interface: IItemsAddedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemsAddedEvent.htm): Event data for the QueueEventType.ItemsAdded event
  - Second paragraph: index: number
  - Headings: H1: Interface: IItemsAddedEvent | H2: Properties | H3: index | H3: items

- [Interface: IItemsDeletedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemsDeletedEvent.htm): Event data for the QueueEventType.ItemsDeleted event
  - Second paragraph: count: number
  - Headings: H1: Interface: IItemsDeletedEvent | H2: Properties | H3: count | H3: index

- [Interface: IItemsPreloadedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemsPreloadedEvent.htm): Event data for PreloadServiceEventType.ItemsPreloaded event
  - Second paragraph: currentViewerType: RelativityViewerType
  - Headings: H1: Interface: IItemsPreloadedEvent | H2: Properties | H3: currentViewerType | H3: preloadItems

- [Interface: IKeyboardShortcut] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcut.htm): IKeyboardShortcut
  - Second paragraph: name: string
  - Headings: H1: Interface: IKeyboardShortcut | H2: Properties | H3: name | H2: Methods | H3: clearOverride() | H3: disable() | H3: enable() | H3: rebindShortcuts() | H3: setOverride()

- [Interface: IKeyboardShortcutAction] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcutAction.htm): IKeyboardShortcutAction
  - Second paragraph: shortcutFn: () => any
  - Headings: H1: Interface: IKeyboardShortcutAction | H2: Properties | H3: shortcutFn()

- [Interface: IKeyboardShortcutData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcutData.htm): IKeyboardShortcutData
  - Second paragraph: artifactId: number
  - Headings: H1: Interface: IKeyboardShortcutData | H2: Properties | H3: artifactId | H3: fieldData | H3: hotkey | H3: name | H3: type

- [Interface: IKeyboardShortcutManager] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcutManager.htm): Class for adding, accessing, enabling, and disabling keyboard shortcuts.
  - Second paragraph: readonlyshortcutsEnabled: boolean
  - Headings: H1: Interface: IKeyboardShortcutManager | H2: Properties | H3: shortcutsEnabled | H2: Methods | H3: addShortcut() | H3: disableShortcuts() | H3: enableKeyboardShortcutsOnIframe() | H3: enableShortcuts() | H3: getAvailableShortcuts() | H3: getShortcutByName()

- [Interface: IKeyCombination] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyCombination.htm): IKeyCombination
  - Second paragraph: alt: boolean
  - Headings: H1: Interface: IKeyCombination | H2: Properties | H3: alt | H3: ctrl | H3: keycode | H3: shift

- [Interface: ILoadOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ILoadOptions.htm): Options passed to viewer cards as a part of IQueueItem load
  - Second paragraph: optionalcancellationToken: ICancellationToken
  - Headings: H1: Interface: ILoadOptions | H2: Properties | H3: cancellationToken? | H3: forceWebView? | H3: longTextFieldArtifactId? | H3: productionArtifactId? | H3: productionType? | H3: reconvertRequired? | H3: reloadRequired? | H3: transcriptArtifactId?

- [Interface: IMarkupSet] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMarkupSet.htm): Relativity Markup Set
  - Second paragraph: artifactId: number
  - Headings: H1: Interface: IMarkupSet | H2: Properties | H3: artifactId | H3: name | H3: order | H3: redactionText

- [Interface: IMarkupSetChangedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMarkupSetChangedEvent.htm): Event data for the ImageViewerEventType.MarkupSetChanged event
  - Second paragraph: newMarkupSetArtifactId: number
  - Headings: H1: Interface: IMarkupSetChangedEvent | H2: Properties | H3: newMarkupSetArtifactId | H3: oldMarkupSetArtifactId

- [Interface: IMassOperationsService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMassOperationsService.htm): Class for launching mass operations
  - Second paragraph: openMassOperationsModal(name, title, openUrl): Promise<DialogCancellableOpenResult>
  - Headings: H1: Interface: IMassOperationsService | H2: Methods | H3: openMassOperationsModal()

- [Interface: IMessageCardBanner] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMessageCardBanner.htm): Message card banner
  - Second paragraph: bannerClass: string
  - Headings: H1: Interface: IMessageCardBanner | H2: Extends | H2: Properties | H3: bannerClass | H3: card | H3: dismissed | H3: iconClass | H3: message | H3: type | H2: Methods | H3: dismiss() | H3: onClick()

- [Interface: IMessageCardBannerConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMessageCardBannerConfig.htm): Configuration for a message card banner
  - Second paragraph: optionalbannerClass: string
  - Headings: H1: Interface: IMessageCardBannerConfig | H2: Extends | H2: Properties | H3: bannerClass? | H3: iconClass? | H3: onclick()?

- [Interface: IMetricsApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMetricsApi.htm): readonlyattributes: Readonly<IContext>
  - Second paragraph: Global metric attributes
  - Headings: H1: Interface: IMetricsApi | H2: Properties | H3: attributes | H2: Methods | H3: getMetricAttributes() | H3: removeAttribute() | H3: removeMetricAttribute() | H3: setAttribute() | H3: setMetricAttribute()

- [Interface: IMonitoringConfigration] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMonitoringConfigration.htm): Configuration used for providing monitoring data to the Review Interface
  - Second paragraph: optionalisDirectNavigation: boolean
  - Headings: H1: Interface: IMonitoringConfigration | H2: Properties | H3: isDirectNavigation? | H3: pageBaseTimeOrigin?

- [Interface: INameUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INameUpdatedEvent.htm): Event data for the QueueEventType.NameUpdated event
  - Second paragraph: name: string
  - Headings: H1: Interface: INameUpdatedEvent | H2: Properties | H3: name

- [Interface: INativeService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INativeService.htm): Class for interacting with the underyling native file
  - Second paragraph: canReplaceNative(): boolean
  - Headings: H1: Interface: INativeService | H2: Extends | H2: Methods | H3: canReplaceNative() | H3: newNativeFileAdded() | H3: off() | H3: on() | H3: once()

- [Interface: INote<T>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INoteT.htm): Represents a note added by a user to a document
  - Second paragraph: • TextendsNoteType = any
  - Headings: H1: Interface: INote<T> | H2: Type Parameters | H2: Properties | H3: author? | H3: date? | H3: fillColor | H3: id | H3: range | H3: rangeString | H3: text | H3: textColor? | H3: title? | H3: type | H3: userData

- [Interface: INoteManagerApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INoteManagerApi.htm): Partial INoteManager interface that defines the note API methods
  - Second paragraph: addDesignation(target, config): Note<any>
  - Headings: H1: Interface: INoteManagerApi | H2: Remarks | H2: Methods | H3: addDesignation() | H3: byType() | H3: removeDesignation()

- [Interface: INoteManagerEventApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INoteManagerEventApi.htm): Partial INoteManager interface that defines the event handler API methods
  - Second paragraph: offadd(addCallback, refObject?): void
  - Headings: H1: Interface: INoteManagerEventApi | H2: Remarks | H2: Methods | H3: offadd() | H3: offchange() | H3: offremove() | H3: onadd() | H3: onaddonce() | H3: onchange() | H3: onchangeonce() | H3: onremove() | H3: onremoveonce()

- [Interface: IObjectsEntity] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IObjectsEntity.htm): ArtifactID: number
  - Second paragraph: optionalValues: any[]
  - Headings: H1: Interface: IObjectsEntity | H2: Properties | H3: ArtifactID | H3: Values?

- [Interface: IObjectType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IObjectType.htm): ArtifactID: number
  - Second paragraph: ArtifactTypeID: number
  - Headings: H1: Interface: IObjectType | H2: Properties | H3: ArtifactID | H3: ArtifactTypeID | H3: Guids? | H3: Name

- [Interface: IOutsideInViewer] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IOutsideInViewer.htm): OutsideIn viewer instance interface
  - Second paragraph: This provides a special bootstrap method that can take in an OutsideIn View instance.
  - Headings: H1: Interface: IOutsideInViewer | H2: Remarks | H2: Extends | H2: Extended by | H2: Properties | H3: cardActivated()? | H3: cardBuildTabOptions()? | H3: cardBuildToolbarOptions()? | H3: cardCanDeactivate()? | H3: cardCreateUnsupportedOverlayCard()? | H3: cardDeactivated()? | H3: cardError()? | H3: cardLoaded()? | H3: cardLoadState()? | H3: cardMaximized()? | H3: cardResized()? | H3: cardRestored()? | H3: cardSaveState()? | H3: cardUnloaded()? | H3: contextualSearchView | H3: currentPageIndex | H3: currentPageName | H3: designationRendering | H3: hasWaveform | H3: id | H3: loadError | H3: loadSuccessful | H3: oiPagesLoadedCount | H3: showWaveformView | H3: thumbnailView | H3: timelineView | H3: transcriptDesignationRendering | H3: transcriptView | H3: transientHighlight | H3: type | H3: unsupportedTabTitle? | H2: Methods | H3: cardLoadItem() | H3: checkHasFeature() | H3: createCellRange() | H3: createRectRange() | H3: createTextRange() | H3: getAquaView() | H3: getExternalContent() | H3: getFeatureManager() | H3: getHiddenContentStatus() | H3: getObjectsAtPosition() | H3: getObjectsAtTranscriptPosition() | H3: getPageHeight() | H3: getPageWidth() | H3: getSelectionMode() | H3: hasFeature() | H3: hasPaging() | H3: moveToNextPage() | H3: moveToPage() | H3: moveToPreviousPage() | H3: openAboutModal() | H3: openConfirmDeleteImagesModal() | H3: openSaveAsPdfModal() | H3: openSingleFileUploadModal() | H3: selectCellRange() | H3: selectionRange() | H3: selectRectRange() | H3: selectTextRange() | H3: setDesignationRendering() | H3: setExternalContent() | H3: setPageLayoutMode() | H3: setSelectionMode() | H3: setTranscriptDesignationRendering() | H3: showBanner() | H3: showHiddenContent() | H3: toggleFilterDrawer() | H3: toggleThumbnails() | H3: totalPageCount() | H3: zoomIn() | H3: zoomOut() | H3: zoomToFit() | H3: zoomToIndex()

- [Interface: IPartialMetric] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPartialMetric.htm): Partial metric that supports setting, updating, and removing metric attributes as well as registering pre-report event handlers.
  - Second paragraph: readonlyabandoned: boolean
  - Headings: H1: Interface: IPartialMetric | H2: Properties | H3: abandoned | H3: attributes | H3: name | H3: reported | H2: Methods | H3: incrementAttribute() | H3: offPreReport() | H3: onPreReport() | H3: removeAttribute() | H3: setAttribute()

- [Interface: IPerformanceCheckpoint] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPerformanceCheckpoint.htm): Checkpoint data
  - Second paragraph: entry: IPerformanceEntry
  - Headings: H1: Interface: IPerformanceCheckpoint | H2: Properties | H3: entry | H3: name | H3: workflow

- [Interface: IPerformanceEntry] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPerformanceEntry.htm): Performance entry data
  - Second paragraph: readonlyduration: number
  - Headings: H1: Interface: IPerformanceEntry | H2: Properties | H3: duration | H3: entryType | H3: name | H3: startTime | H2: Methods | H3: toJSON()

- [Interface: IPerformanceWorkflow] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPerformanceWorkflow.htm): Workflow to monitor for performance
  - Second paragraph: readonlycontext: Readonly<IContext>
  - Headings: H1: Interface: IPerformanceWorkflow | H2: Properties | H3: context | H3: id | H3: name | H3: startTime | H2: Methods | H3: checkpoint() | H3: checkpointWithEndName() | H3: complete() | H3: getCheckpoint() | H3: getCheckpointTimeFromStart() | H3: getDuration() | H3: incrementContext() | H3: setContext() | H3: start()

- [Interface: IPermissionCheckRequest] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPermissionCheckRequest.htm): A cached representation of the user's extension permissions request.
  - Second paragraph: optionalartifactId: number
  - Headings: H1: Interface: IPermissionCheckRequest | H2: Properties | H3: artifactId? | H3: artifactTypeId | H3: permissionName

- [Interface: IPersistentHighlightCountUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightCountUpdatedEvent.htm): Event data for the ViewerHighlightEventType.PersistentHighlightCountUpdated event
  - Second paragraph: isNew: boolean
  - Headings: H1: Interface: IPersistentHighlightCountUpdatedEvent | H2: Properties | H3: isNew | H3: setCount | H3: setRendered | H3: termArtifactId | H3: termCount | H3: termRendered

- [Interface: IPersistentHighlightExpandedUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightExpandedUpdatedEvent.htm): Event data for the ViewerHighlightEventType.PersistentHighlightExpandedUpdated event
  - Second paragraph: expanded: boolean
  - Headings: H1: Interface: IPersistentHighlightExpandedUpdatedEvent | H2: Properties | H3: expanded | H3: setArtifactId

- [Interface: IPersistentHighlightSelectedUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightSelectedUpdatedEvent.htm): Event data for the ViewerHighlightEventType.PersistentHighlightSelectedUpdated event
  - Second paragraph: selected: boolean
  - Headings: H1: Interface: IPersistentHighlightSelectedUpdatedEvent | H2: Properties | H3: selected | H3: setArtifactId | H3: termArtifactId?

- [Interface: IPersistentHighlightSet] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightSet.htm): Object used to display PersistentHighlight Sets in the UI
  - Second paragraph: count: number
  - Headings: H1: Interface: IPersistentHighlightSet | H2: Properties | H3: count | H3: expanded | H3: hasEditPermission | H3: id | H3: order | H3: persistentHighlightSetArtifactId | H3: persistentHighlightTerms | H3: renderedTermCount | H3: selected | H3: setName | H3: syntax | H3: visible

- [Interface: IPersistentHighlightsUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightsUpdatedEvent.htm): Event data for the ViewerHighlightEventType.PersistentHighlightsUpdated event
  - Second paragraph: persistentHighlightData: IPersistentHighlightSet[]
  - Headings: H1: Interface: IPersistentHighlightsUpdatedEvent | H2: Properties | H3: persistentHighlightData

- [Interface: IPersistentHighlightTerm] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightTerm.htm): Object used to display PersistentHighlight Terms in the UI
  - Second paragraph: readonlybackgroundColor: string
  - Headings: H1: Interface: IPersistentHighlightTerm | H2: Properties | H3: backgroundColor | H3: count | H3: foregroundColor | H3: id | H3: isElasticSearchTerm? | H3: isNew? | H3: isZeroHitStrTerm? | H3: persistentHighlightSetArtifactId | H3: persistentHighlightTermArtifactId | H3: searchData? | H3: selected | H3: syntax | H3: term | H3: visible

- [Interface: IPersistentHighlightTermAddedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightTermAddedEvent.htm): Event data for the HighlightServiceEventType.PersistentHighlightTermAdded event
  - Second paragraph: setId: number
  - Headings: H1: Interface: IPersistentHighlightTermAddedEvent | H2: Properties | H3: setId | H3: syntax | H3: terms

- [Interface: IPersistentHighlightVisibilityUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightVisibilityUpdatedEvent.htm): Event data for the ViewerHighlightEventType.PersistentHighlightVisibilityUpdated event
  - Second paragraph: setArtifactId: number
  - Headings: H1: Interface: IPersistentHighlightVisibilityUpdatedEvent | H2: Properties | H3: setArtifactId | H3: termArtifactId? | H3: visible

- [Interface: IPointerCreatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPointerCreatedEvent.htm): Event data for the QueueEventType.PointerCreated event
  - Second paragraph: pointer: IQueuePointer
  - Headings: H1: Interface: IPointerCreatedEvent | H2: Properties | H3: pointer

- [Interface: IPopupControlApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPopupControlApi.htm): closePopup: () => undefined
  - Second paragraph: Closes the pop-up window referenced by the popup property when it's safe to do so
  - Headings: H1: Interface: IPopupControlApi | H2: Properties | H3: closePopup() | H3: isPopupSafeAndLive() | H3: popup

- [Interface: IPopupEventNames] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPopupEventNames.htm): readonlyCREATE_ACTION_BAR: "createActionBar"
  - Second paragraph: readonlyCREATE_CONSOLE: "createConsole"
  - Headings: H1: Interface: IPopupEventNames | H2: Properties | H3: CREATE_ACTION_BAR | H3: CREATE_CONSOLE | H3: EVENT_HANDLERS_REGISTERED | H3: HYDRATE_LAYOUT | H3: HYDRATE_LAYOUT_COMPLETE | H3: ITEM_LIST_MODIFY_ACTIONS | H3: ITEM_LIST_MODIFY_COLUMNS | H3: ITEM_LIST_RELOADED | H3: OVERRIDE_PICKER_DATASOURCE | H3: PAGE_INTERACTION | H3: PAGE_LOAD_COMPLETE | H3: PAGE_UNLOAD | H3: POST_DELETE | H3: POST_OBTAIN_ADDITIONAL_DATA | H3: POST_SAVE | H3: PRE_DELETE | H3: PRE_SAVE | H3: REPLACE_DELETE | H3: REPLACE_FILE_ACTIONS | H3: REPLACE_GET_NEW_OBJECT_INSTANCE | H3: REPLACE_OBTAIN_ADDITIONAL_DATA | H3: REPLACE_READ | H3: REPLACE_READ_DELETE_DEPENDENCY_LIST | H3: REPLACE_SAVE | H3: TRANSFORM_LAYOUT | H3: UPDATE_ACTION_BAR | H3: UPDATE_CONSOLE | H3: VALIDATE_SAVE | H3: VALIDATION

- [Interface: IPreloadItem] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPreloadItem.htm): Information about IQueueItems to be pre-loaded
  - Second paragraph: queueItems: IQueueItem[]
  - Headings: H1: Interface: IPreloadItem | H2: Properties | H3: queueItems | H3: viewerType

- [Interface: IPreloadService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPreloadService.htm): Preload service to retrieve document data prior to the viewer call and store in cache
  - Second paragraph: abort(viewerCollection): Promise<void>
  - Headings: H1: Interface: IPreloadService | H2: Extends | H2: Methods | H3: abort() | H3: off() | H3: on() | H3: once() | H3: prepareDocuments() | H3: prepareQueue() | H3: prepareViewerQueue()

- [Interface: IPrepareQueueOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPrepareQueueOptions.htm): Options used to fine-tune how document preparation runs
  - Second paragraph: optionalcancellationToken: ICancellationToken
  - Headings: H1: Interface: IPrepareQueueOptions | H2: Properties | H3: cancellationToken? | H3: prepareTarget? | H3: viewerCollection?

- [Interface: IPreviewApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPreviewApi.htm): The preview API is designed for consumption by the Fluid Item List application and exposes specific APIs used to power the Document Preview Panel.
  - Second paragraph: off(eventType, handler?, once?): void
  - Headings: H1: Interface: IPreviewApi | H2: Extends | H2: Methods | H3: off() | H3: on() | H3: once() | H3: popin() | H3: popout() | H3: setDocument() | H3: setQueue()

- [Interface: IProductionHistoryItem] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IProductionHistoryItem.htm): Object used to display Document Production History items in the UI
  - Second paragraph: readonlyArtifactID: number
  - Headings: H1: Interface: IProductionHistoryItem | H2: Properties | H3: ArtifactID | H3: BeginAttachment | H3: BeginBates | H3: DateProduced | H3: EndAttachment | H3: EndBates | H3: Name | H3: WorkspaceID

- [Interface: IProductionHistoryService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IProductionHistoryService.htm): Class for working with Production History
  - Second paragraph: getProductionHistory(documentId, refreshCache?): Promise<IProductionHistoryItem[]>
  - Headings: H1: Interface: IProductionHistoryService | H2: Methods | H3: getProductionHistory()

- [Interface: IProductionViewer] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IProductionViewer.htm): Production Viewer IViewerCardInstance
  - Second paragraph: optionalcardActivated: (api, card) => void
  - Headings: H1: Interface: IProductionViewer | H2: Extends | H2: Properties | H3: cardActivated()? | H3: cardBuildTabOptions()? | H3: cardBuildToolbarOptions()? | H3: cardCanDeactivate()? | H3: cardCreateUnsupportedOverlayCard()? | H3: cardDeactivated()? | H3: cardError()? | H3: cardLoaded()? | H3: cardLoadState()? | H3: cardMaximized()? | H3: cardResized()? | H3: cardRestored()? | H3: cardSaveState()? | H3: cardUnloaded()? | H3: contextualSearchView | H3: currentPageIndex | H3: currentPageName | H3: designationRendering | H3: hasWaveform | H3: highlights | H3: id | H3: loadError | H3: loadSuccessful | H3: oiPagesLoadedCount | H3: shouldHighlight | H3: showWaveformView | H3: thumbnailView | H3: timelineView | H3: transcriptDesignationRendering | H3: transcriptView | H3: transientHighlight | H3: type | H3: unsupportedTabTitle? | H2: Methods | H3: cardLoadItem() | H3: checkHasFeature() | H3: createCellRange() | H3: createRectRange() | H3: createTextRange() | H3: getAquaView() | H3: getExternalContent() | H3: getFeatureManager() | H3: getHiddenContentStatus() | H3: getObjectsAtPosition() | H3: getObjectsAtTranscriptPosition() | H3: getPageHeight() | H3: getPageRotation() | H3: getPageWidth() | H3: getSelectionMode() | H3: hasFeature() | H3: hasPaging() | H3: moveToNextPage() | H3: moveToPage() | H3: moveToPreviousPage() | H3: off() | H3: on() | H3: once() | H3: openAboutModal() | H3: openConfirmDeleteImagesModal() | H3: openSaveAsPdfModal() | H3: openSingleFileUploadModal() | H3: rotateAllPagesClockwise() | H3: rotateCurrentPageClockwise() | H3: selectCellRange() | H3: selectionRange() | H3: selectRectRange() | H3: selectTextRange() | H3: setDesignationRendering() | H3: setExternalContent() | H3: setPageLayoutMode() | H3: setPageRotation() | H3: setPageRotationAllImages() | H3: setSelectionMode() | H3: setTranscriptDesignationRendering() | H3: showBanner() | H3: showHiddenContent() | H3: toggleFilterDrawer() | H3: toggleThumbnails() | H3: totalPageCount() | H3: zoomIn() | H3: zoomOut() | H3: zoomToFit() | H3: zoomToIndex()

- [Interface: IPublicDocumentData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPublicDocumentData.htm): Bundle of public information about a document
  - Second paragraph: fileExtension: string
  - Headings: H1: Interface: IPublicDocumentData | H2: Properties | H3: fileExtension | H3: hasNativeFileDownloadPermission | H3: nativeData? | H3: preventNativeDownload | H3: redactFileInfo | H3: redactProductionLock

- [Interface: IPublicDocumentNativeData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPublicDocumentNativeData.htm): Data about the document native, if one exists
  - Second paragraph: fileTypeId: number
  - Headings: H1: Interface: IPublicDocumentNativeData | H2: Properties | H3: fileTypeId | H3: relativityNativeType

- [Interface: IQueue] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueue.htm): Service for managing a set of IQueueItems to work with
  - Second paragraph: readonlycustomData: ICustomData
  - Headings: H1: Interface: IQueue | H2: Extends | H2: Properties | H3: customData | H3: id | H3: length | H3: name | H3: pointers | H2: Methods | H3: addItemAtEnd() | H3: addItemAtIndex() | H3: addItemsAtEnd() | H3: addItemsAtIndex() | H3: createPointer() | H3: deleteItemAtIndex() | H3: deleteItemsAtIndex() | H3: getDocumentIds() | H3: getDocumentItemIndex() | H3: getItem() | H3: getItems() | H3: getQueueItemIdentifiers() | H3: getQueueItemIndex() | H3: itemsEquivalent() | H3: moveItemsToIndex() | H3: moveItemToIndex() | H3: off() | H3: on() | H3: once() | H3: setCustomData()

- [Interface: IQueueCreatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueCreatedEvent.htm): Event data for the QueueServiceEventType.QueueCreated event
  - Second paragraph: queue: IQueue
  - Headings: H1: Interface: IQueueCreatedEvent | H2: Properties | H3: queue

- [Interface: IQueueDeletedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueDeletedEvent.htm): Event data for the QueueServiceEventType.QueueDeleted event
  - Second paragraph: queue: IQueue
  - Headings: H1: Interface: IQueueDeletedEvent | H2: Properties | H3: queue

- [Interface: IQueueItem] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueItem.htm): Item that can be added to a IQueue and viewed in an IViewerCardInstance
  - Second paragraph: extension: string
  - Headings: H1: Interface: IQueueItem | H2: Extended by | H2: Properties | H3: extension | H3: id | H3: itemIdentifier | H3: itemTransforms? | H3: label | H3: type

- [Interface: IQueueItemIdentifier] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueItemIdentifier.htm): Item that can be used to identify a IQueueItem
  - Second paragraph: readonlyoptionalid: string
  - Headings: H1: Interface: IQueueItemIdentifier | H2: Extended by | H2: Properties | H3: id?

- [Interface: IQueuePointer] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueuePointer.htm): Class for managing a position in an IQueue
  - Second paragraph: This entity is used by IViewerCollections, IViewerCardInstances, and other entities to determine when to navigate and which IQueueItem is active
  - Headings: H1: Interface: IQueuePointer | H2: Extends | H2: Properties | H3: activationStatus | H3: id | H3: index | H3: item | H3: longTextArtifactId | H3: productionArtifactId | H3: productionType | H3: queue | H3: type | H2: Methods | H3: activate() | H3: copy() | H3: navigate() | H3: navigateBy() | H3: navigateToFirst() | H3: navigateToIndex() | H3: navigateToLast() | H3: navigateToNext() | H3: navigateToPrevious() | H3: off() | H3: on() | H3: once() | H3: requestUpdate() | H3: switchViewer()

- [Interface: IQueuePointerChangedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueuePointerChangedEvent.htm): Event data for the ViewerCollectionEventType.QueuePointerChanged event
  - Second paragraph: newPointer: IQueuePointer
  - Headings: H1: Interface: IQueuePointerChangedEvent | H2: Properties | H3: newPointer | H3: oldPointer

- [Interface: IQueueService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueService.htm): Service for managing IQueues
  - Second paragraph: readonlyqueues: IQueue[]
  - Headings: H1: Interface: IQueueService | H2: Extends | H2: Properties | H3: queues | H2: Methods | H3: createDocumentItem() | H3: createQueue() | H3: createRdoFileItem() | H3: deleteQueue() | H3: getQueueById() | H3: off() | H3: on() | H3: once()

- [Interface: IRangeMementoHelper] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRangeMementoHelper.htm): createLineRangeMementos(textRangeMemento): LineRangeMemento[]
  - Second paragraph: Returns an array of LineRangeMementos that represent the text range from the specified TextRangeMemento
  - Headings: H1: Interface: IRangeMementoHelper | H2: Methods | H3: createLineRangeMementos() | H3: createTextRangeMemento()

- [Interface: IRDOFileItem] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRDOFileItem.htm): Relativity Dynamic Object file field file queue item
  - Second paragraph: extension: string
  - Headings: H1: Interface: IRDOFileItem | H2: Extends | H2: Properties | H3: extension | H3: fileFieldArtifactId | H3: fileId | H3: id | H3: itemIdentifier | H3: itemTransforms? | H3: label | H3: type

- [Interface: IRDOFileItemIdentifier] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRDOFileItemIdentifier.htm): Item that can be used to identify a IRDOFileItem
  - Second paragraph: readonlyfileFieldArtifactId: number
  - Headings: H1: Interface: IRDOFileItemIdentifier | H2: Extends | H2: Properties | H3: fileFieldArtifactId | H3: fileId | H3: id?

- [Interface: IRecentSearchSetExpandedStateUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchSetExpandedStateUpdatedEvent.htm): Event data for the HighlightServiceEventType.RecentSearchSetExpandedStateUpdated event
  - Second paragraph: expanded: boolean
  - Headings: H1: Interface: IRecentSearchSetExpandedStateUpdatedEvent | H2: Properties | H3: expanded

- [Interface: IRecentSearchSetUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchSetUpdatedEvent.htm): Event data for the ViewerHighlightEventType.RecentSearchSetUpdated event
  - Second paragraph: recentSearchSetData: IPersistentHighlightSet
  - Headings: H1: Interface: IRecentSearchSetUpdatedEvent | H2: Properties | H3: recentSearchSetData

- [Interface: IRecentSearchSetVisibilityUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchSetVisibilityUpdatedEvent.htm): Event data for the HighlightServiceEventType.RecentSearchSetVisibilityUpdated event
  - Second paragraph: visible: boolean
  - Headings: H1: Interface: IRecentSearchSetVisibilityUpdatedEvent | H2: Properties | H3: visible

- [Interface: IRecentSearchTermAddedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermAddedEvent.htm): Event data for the HighlightServiceEventType.RecentSearchTermAdded event
  - Second paragraph: activeViewerType: RelativityViewerType
  - Headings: H1: Interface: IRecentSearchTermAddedEvent | H2: Properties | H3: activeViewerType | H3: termArtifactId

- [Interface: IRecentSearchTermClearedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermClearedEvent.htm): Event data for the HighlightServiceEventType.RecentSearchTermCleared event
  - Second paragraph: termArtifactIds: number[]
  - Headings: H1: Interface: IRecentSearchTermClearedEvent | H2: Properties | H3: termArtifactIds

- [Interface: IRecentSearchTermCountUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermCountUpdatedEvent.htm): Event data for the HighlightServiceEventType.RecentSearchTermCountUpdated event
  - Second paragraph: setCount: number
  - Headings: H1: Interface: IRecentSearchTermCountUpdatedEvent | H2: Properties | H3: setCount | H3: setRendered | H3: termArtifactId | H3: termCount | H3: termRendered | H3: viewerType

- [Interface: IRecentSearchTermVisibilityUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermVisibilityUpdatedEvent.htm): Event data for the HighlightServiceEventType.RecentSearchTermVisibilityUpdated event
  - Second paragraph: termArtifactId: number
  - Headings: H1: Interface: IRecentSearchTermVisibilityUpdatedEvent | H2: Properties | H3: termArtifactId | H3: visible

- [Interface: IRedactFileInfo] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRedactFileInfo.htm): Redact data for the document
  - Second paragraph: documentArtifactId: number
  - Headings: H1: Interface: IRedactFileInfo | H2: Properties | H3: documentArtifactId | H3: redactFileFieldArtifactId | H3: redactFileId | H3: redactFileLastUpdated | H3: redactMarkupSetId

- [Interface: IRelatedItemsService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelatedItemsService.htm): Class for interacting with the related items pane.
  - Second paragraph: readonlycurrentPane: string
  - Headings: H1: Interface: IRelatedItemsService | H2: Properties | H3: currentPane | H3: paneColumns | H3: paneData | H3: panes

- [Interface: IRelationalField] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelationalField.htm): ArtifactID: number
  - Second paragraph: FieldCategory: string
  - Headings: H1: Interface: IRelationalField | H2: Properties | H3: ArtifactID | H3: FieldCategory | H3: FieldType | H3: Guids? | H3: ViewFieldID

- [Interface: IRelativityConfiguration] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityConfiguration.htm): Configuration used for communicating with a Relativity Instance
  - Second paragraph: optionalauthMode: AuthMode
  - Headings: H1: Interface: IRelativityConfiguration | H2: Properties | H3: authMode? | H3: baseUrl? | H3: bearerToken? | H3: enableRelativityInternalRouting? | H3: environmentType | H3: initialIndex | H3: initialLongTextArtifactId? | H3: initialPageLayout? | H3: initialProductionArtifactId? | H3: initialProductionType? | H3: initialReviewQueueDocuments? | H3: initialReviewQueueItemIdentifiers? | H3: initialThumbnailVisibility | H3: initialType | H3: initialZoomLevel | H3: initialZoomMode | H3: region | H3: servicesBaseUrl? | H3: tenantId | H3: workspaceId

- [Interface: IRelativityFormsActionBarAPI] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsActionBarAPI.htm): The actionBar api used to default actions supported by Relativity Forms
  - Second paragraph: defaultActions: IRelativityFormsDefaultActionsAPI
  - Headings: H1: Interface: IRelativityFormsActionBarAPI | H2: Properties | H3: defaultActions

- [Interface: IRelativityFormsConvenienceAPI] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsConvenienceAPI.htm): The convienience api interface returned from RelativityForms setConvenienceAPI()
  - Second paragraph: actionBar: IRelativityFormsActionBarAPI
  - Headings: H1: Interface: IRelativityFormsConvenienceAPI | H2: Properties | H3: actionBar | H3: fieldHelper | H3: layout | H3: navigation | H3: relativityFormsPopup | H2: Methods | H3: getCurrentFormState()

- [Interface: IRelativityFormsDefaultActionsAPI] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsDefaultActionsAPI.htm): The actions to take on the default actions api via the convenience api
  - Second paragraph: save(): Promise<void>
  - Headings: H1: Interface: IRelativityFormsDefaultActionsAPI | H2: Methods | H3: save() | H3: saveAndContinue() | H3: saveAndGo()

- [Interface: IRelativityFormsEnvelope] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelope.htm): A data object used to communicate with Relativity Forms
  - Second paragraph: optionaldispatchEvent: (event) => void
  - Headings: H1: Interface: IRelativityFormsEnvelope | H2: Properties | H3: dispatchEvent()? | H3: getPreloadObjectIds()? | H3: modal? | H3: navigate()? | H3: setConvenienceApi()? | H3: settings?

- [Interface: IRelativityFormsEnvelopeActionBarSettings] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeActionBarSettings.htm): Settings used to configure the Relativity Form Action Bar
  - Second paragraph: optionalcustomButtons: IRelativityFormsEnvelopeCustomButtonSettings[]
  - Headings: H1: Interface: IRelativityFormsEnvelopeActionBarSettings | H2: Properties | H3: customButtons? | H3: hideBack? | H3: hideCancel? | H3: hideDelete? | H3: hideEdit? | H3: hideEditPermissions? | H3: hidePager? | H3: hideSave? | H3: hideSaveAndBack? | H3: hideSaveAndNew? | H3: hideSaveAndNext? | H3: hideSaveAndPrevious? | H3: hideViewAudit? | H3: layoutControlsSlotPosition?

- [Interface: IRelativityFormsEnvelopeCustomButtonSettings] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeCustomButtonSettings.htm): Settings for a custom button in the action bar
  - Second paragraph: actionType: RelativityFormCustomButtonActionType
  - Headings: H1: Interface: IRelativityFormsEnvelopeCustomButtonSettings | H2: Properties | H3: actionType | H3: className | H3: id | H3: isDisabled | H3: name | H3: onBuild()? | H3: onClick() | H3: order | H3: slotPosition | H3: visibleMode

- [Interface: IRelativityFormsEnvelopeModal] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeModal.htm): This namespace contains the methods for Relativity Forms to call when they open/close a modal
  - Second paragraph: close: () => Promise<void>
  - Headings: H1: Interface: IRelativityFormsEnvelopeModal | H2: Properties | H3: close() | H3: open()

- [Interface: IRelativityFormsEnvelopeSettings] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeSettings.htm): Settings that help configure the Relativity Form
  - Second paragraph: optionalactionBar: IRelativityFormsEnvelopeActionBarSettings
  - Headings: H1: Interface: IRelativityFormsEnvelopeSettings | H2: Properties | H3: actionBar? | H3: appGuids? | H3: canControlRelativityWindow? | H3: enableChildAndAssociativeListsInEditMode? | H3: enableCompactMode? | H3: enableCopyFromPrevious? | H3: enablePropagation?

- [Interface: IRelativityFormsFieldHelper] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsFieldHelper.htm): Api for accessing and modifying fields
  - Second paragraph: getHtmlElement(identifier): Promise<IRwcHtmlElement>
  - Headings: H1: Interface: IRelativityFormsFieldHelper | H2: Methods | H3: getHtmlElement() | H3: getValue() | H3: setCopyFromPreviousState() | H3: setValue()

- [Interface: IRelativityFormsLayout] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayout.htm): Interface to represent a Relativity Forms Layout
  - Second paragraph: AllowCopyFromPrevious: boolean
  - Headings: H1: Interface: IRelativityFormsLayout | H2: Properties | H3: AllowCopyFromPrevious | H3: ArtifactTypeId | H3: Groups | H3: Guids | H3: IsLocked | H3: LayoutID | H3: Name | H3: OverwriteProtection

- [Interface: IRelativityFormsLayoutFieldElement] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutFieldElement.htm): Interface to represent a Field Elements
  - Second paragraph: AllowCopyFromPrevious: boolean
  - Headings: H1: Interface: IRelativityFormsLayoutFieldElement | H2: Properties | H3: AllowCopyFromPrevious | H3: AllowHTML | H3: ColSpan | H3: Column | H3: copyFromPreviousState | H3: DisplayName | H3: DisplayType? | H3: expanded | H3: FieldCategoryID | H3: FieldID | H3: FieldType | H3: Guids | H3: IsReadOnly | H3: IsRequired | H3: IsSystem | H3: MaxLength? | H3: minimumWidth | H3: NameValue | H3: RepeatColumn? | H3: Row | H3: ShowNameColumn

- [Interface: IRelativityFormsLayoutGroup] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutGroup.htm): Interface to represent a Group on a Relativity Forms Layout
  - Second paragraph: Elements: IRelativityFormsLayoutGroupElement[]
  - Headings: H1: Interface: IRelativityFormsLayoutGroup | H2: Properties | H3: Elements | H3: GroupID | H3: Order | H3: TabbedDisplay

- [Interface: IRelativityFormsLayoutGroupElement] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutGroupElement.htm): Interface to represent a Group Element on a Relativity Forms Layout
  - Second paragraph: CategoryID: number
  - Headings: H1: Interface: IRelativityFormsLayoutGroupElement | H2: Properties | H3: CategoryID | H3: Collapsible | H3: DefaultCollapsed | H3: Elements | H3: Order | H3: Titles

- [Interface: IRelativityFormsLayoutHelper] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutHelper.htm): Layout API used with Relativity Forms
  - Second paragraph: getFields(layoutGroups): IRelativityFormsLayoutFieldElement[]
  - Headings: H1: Interface: IRelativityFormsLayoutHelper | H2: Methods | H3: getFields()

- [Interface: IRelativityFormsNavigateToFormNavigationOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsNavigateToFormNavigationOptions.htm): The additional options that can be used when navigating Forms
  - Second paragraph: optionalshouldFirePageUnloadEventHandlers: boolean
  - Headings: H1: Interface: IRelativityFormsNavigateToFormNavigationOptions | H2: Properties | H3: shouldFirePageUnloadEventHandlers? | H3: showLoader? | H3: skipVolatileDataWarning?

- [Interface: IRelativityFormsNavigateToFormParameters] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsNavigateToFormParameters.htm): The parameters needed to update the Relativity Forms Mode
  - Second paragraph: artifactId: number
  - Headings: H1: Interface: IRelativityFormsNavigateToFormParameters | H2: Properties | H3: artifactId | H3: artifactTypeId | H3: workspaceId

- [Interface: IRelativityFormsNavigationAPI] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsNavigationAPI.htm): The Relativity Forms Navigation API
  - Second paragraph: navigateToArtifactId(artifactId): Promise<void>
  - Headings: H1: Interface: IRelativityFormsNavigationAPI | H2: Methods | H3: navigateToArtifactId() | H3: navigateToForm()

- [Interface: IRelativityFormsPopupFactory] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsPopupFactory.htm): openAdd: (options) => IPopupControlApi
  - Second paragraph: • options: PopupFactoryOptionsForNewObject
  - Headings: H1: Interface: IRelativityFormsPopupFactory | H2: Properties | H3: openAdd() | H3: openEdit() | H3: openView()

- [Interface: IRelativityFormsSaveOperation] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsSaveOperation.htm): represents the current save underway in Relativity Forms
  - Second paragraph: optionalartifactId: number
  - Headings: H1: Interface: IRelativityFormsSaveOperation | H2: Properties | H3: artifactId? | H3: saveOperation?

- [Interface: IRelativityFormsState] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsState.htm): A snapshot of the relativity forms state
  - Second paragraph: artifactId: number
  - Headings: H1: Interface: IRelativityFormsState | H2: Properties | H3: artifactId | H3: artifactTypeId | H3: backingModelData | H3: currentSaveOperation | H3: fieldNameToFieldIdMap | H3: isDirty | H3: isSaveInProgress | H3: layoutId | H3: layoutMetadataCopy | H3: parentArtifactId | H3: viewModelName | H3: volatileModelData | H3: workspaceId

- [Interface: IRelativityTenantContext] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityTenantContext.htm): Relativity tenant context information parsed from Foundation environment metadata
  - Second paragraph: readonlyenvironmentType: string
  - Headings: H1: Interface: IRelativityTenantContext | H2: Properties | H3: environmentType | H3: instanceGuid | H3: podId | H3: regionId | H3: ringId | H3: ringOrder | H3: tenantId

- [Interface: IReloadCompletedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReloadCompletedEvent.htm): Event data for the ViewerCollectionEventType.ReloadCompleted event
  - Second paragraph: optionalreloadError: Error
  - Headings: H1: Interface: IReloadCompletedEvent | H2: Properties | H3: reloadError? | H3: reloadSuccessful

- [Interface: IReloadOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReloadOptions.htm): Options available when calling reload on IViewerCollection
  - Second paragraph: optionalreconvert: boolean
  - Headings: H1: Interface: IReloadOptions | H2: Properties | H3: reconvert?

- [Interface: IRenderContentHighlightsParameters<VType, CType, CTType, CKType, CVType>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRenderContentHighlightsParametersVType__CType__CTType__CKType__CVType.htm): Parameters passed to content highlighting features' render functions
  - Second paragraph: • VTypeextendsIViewerCardInstance = IViewerCardInstance
  - Headings: H1: Interface: IRenderContentHighlightsParameters<VType, CType, CTType, CKType, CVType> | H2: Type Parameters | H2: Properties | H3: abortSignal | H3: api | H3: cache | H3: content | H3: documentMetric | H3: forceRefresh | H3: highlightingApi? | H3: viewer | H3: viewerCollection | H3: workflow

- [Interface: IReportOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReportOptions.htm): Reporting options for the Performance Monitor
  - Second paragraph: optionalreportTimeout: number
  - Headings: H1: Interface: IReportOptions | H2: Properties | H3: reportTimeout? | H3: ReportToAPM? | H3: ReportToConsole?

- [Interface: IRequestMessage] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRequestMessage.htm): baseUrl: string
  - Second paragraph: The base url that the request url is joined with.
  - Headings: H1: Interface: IRequestMessage | H2: Properties | H3: baseUrl | H3: content | H3: headers | H3: method | H3: traditional | H3: url | H2: Methods | H3: buildFullUrl()

- [Interface: IReviewInterfaceApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReviewInterfaceApi.htm): readonlyannotations: IAnnotationsService
  - Second paragraph: The Annotations API is for interacting with annotations (a.k.a. Relativity markups, image highlights and redactions) and markup sets.
  - Headings: H1: Interface: IReviewInterfaceApi | H2: Properties | H3: annotations | H3: cards | H3: configuration | H3: contextMenu | H3: convenienceApi | H3: documentActions | H3: documentDataCacheManager | H3: documentList | H3: embeddedContextKey? | H3: extensions | H3: fileService | H3: highlights | H3: imaging | H3: keyboardShortcuts | H3: lifecycle | H3: preload | H3: toolbar | H3: utilities | H3: version | H3: viewer | H3: viewerContentKeyCacheManager | H3: viewerSettings | H3: window | H2: Methods | H3: off() | H3: on()

- [Interface: IRotatableViewer] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRotatableViewer.htm): Rotation API for IViewerCardInstances
  - Second paragraph: getPageRotation(index): number
  - Headings: H1: Interface: IRotatableViewer | H2: Extended by | H2: Methods | H3: getPageRotation() | H3: rotateAllPagesClockwise() | H3: rotateCurrentPageClockwise() | H3: setPageRotation() | H3: setPageRotationAllImages()

- [Interface: IRotationApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRotationApi.htm): API for interacting with the page rotation of a IViewerCardInstance
  - Second paragraph: rotateAllPagesClockwise(): Promise<boolean>
  - Headings: H1: Interface: IRotationApi | H2: Methods | H3: rotateAllPagesClockwise() | H3: rotateCurrentPageClockwise() | H3: setPageRotation() | H3: setPageRotationAllImages()

- [Interface: IRTCMessageHandler] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRTCMessageHandler.htm): Definitions for subscribing to and handle real time notification messages sent to the browser, such as from signalR
  - Second paragraph: handler: RTCMessageHandlerFn
  - Headings: H1: Interface: IRTCMessageHandler | H2: Properties | H3: handler | H3: messageHandler? | H3: messageName? | H3: name

- [Interface: IRwcHtmlElement] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRwcHtmlElement.htm): disabled: boolean
  - Second paragraph: Field is disabled on form
  - Headings: H1: Interface: IRwcHtmlElement | H2: Properties | H3: disabled | H3: editMode | H2: Methods | H3: focus()

- [Interface: ISearchEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISearchEvent.htm): hasResults: boolean
  - Second paragraph: Indicates if the search term was found in the document
  - Headings: H1: Interface: ISearchEvent | H2: Properties | H3: hasResults | H3: searchTerm | H3: viewerType

- [Interface: ISearchManager] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISearchManager.htm): findAll(searchTerm, config?, ...args?): Promise<TextSearchResult[]>
  - Second paragraph: • searchTerm: string
  - Headings: H1: Interface: ISearchManager | H2: Methods | H3: findAll()

- [Interface: ISetGroupOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISetGroupOptions.htm): Options for creating a new set group
  - Second paragraph: optionalvisibilityPersistenceMode: VisibilityPersistenceMode
  - Headings: H1: Interface: ISetGroupOptions | H2: Properties | H3: visibilityPersistenceMode?

- [Interface: ISetting<T>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISettingT.htm): Class for working with Viewer Settings Card and holding the information
  - Second paragraph: • T
  - Headings: H1: Interface: ISetting<T> | H2: Type Parameters | H2: Properties | H3: defaultValue | H3: handlerFn() | H3: loadedValue? | H3: name | H3: note? | H3: status? | H3: type | H3: value

- [Interface: ISettingGroup] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISettingGroup.htm): Class for working with Viewer Settings Card and holding the information
  - Second paragraph: settings: ISetting<any>[]
  - Headings: H1: Interface: ISettingGroup | H2: Properties | H3: settings | H3: title

- [Interface: ISettingNote] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISettingNote.htm): Class for working with Viewer Settings Card and holding the setting note information
  - Second paragraph: optionaltext: string
  - Headings: H1: Interface: ISettingNote | H2: Properties | H3: text? | H3: title?

- [Interface: IShiftedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IShiftedEvent.htm): Event data for the QueuePointerEventType.Shifted event
  - Second paragraph: currentIndex: number
  - Headings: H1: Interface: IShiftedEvent | H2: Properties | H3: currentIndex | H3: previousIndex

- [Interface: IShortcutFieldData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IShortcutFieldData.htm): IShortcutFieldData
  - Second paragraph: fieldName: string
  - Headings: H1: Interface: IShortcutFieldData | H2: Properties | H3: fieldName | H3: fieldType

- [Interface: ISkeletonShownEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISkeletonShownEvent.htm): Event data for the ViewerCollectionEventType.SkeletonShown event
  - Second paragraph: item: IQueueItem
  - Headings: H1: Interface: ISkeletonShownEvent | H2: Properties | H3: item | H3: skeletonType | H3: viewerType

- [Interface: ISmartHighlightExtensionConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISmartHighlightExtensionConfig.htm): This is an experimental interface and not ready for production use. Expect breaking changes in the future.
  - Second paragraph: readonlycardId: string
  - Headings: H1: Interface: ISmartHighlightExtensionConfig | H2: Properties | H3: cardId | H3: id | H3: onRender() | H3: order | H3: supportedViewers

- [Interface: ISmartHighlightsApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISmartHighlightsApi.htm): This is an experimental API and not ready for production use. Expect breaking changes in the future.
  - Second paragraph: addFirstTerm(term): string
  - Headings: H1: Interface: ISmartHighlightsApi | H2: Methods | H3: addFirstTerm() | H3: addHighlight() | H3: addTerm() | H3: createHighlightSet()

- [Interface: ISmartHighlightsDocumentLoadDetails] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISmartHighlightsDocumentLoadDetails.htm): This is an experimental interface and not ready for production use. Expect breaking changes in the future.
  - Second paragraph: documentId: number
  - Headings: H1: Interface: ISmartHighlightsDocumentLoadDetails | H2: Properties | H3: documentId | H3: workspaceId

- [Interface: ISortIdentifier] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISortIdentifier.htm): Direction: string
  - Second paragraph: FieldIdentifier: IFieldIdentifier
  - Headings: H1: Interface: ISortIdentifier | H2: Properties | H3: Direction | H3: FieldIdentifier | H3: Order?

- [Interface: ITextData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextData.htm): Information about the text of an IAnnotation
  - Second paragraph: redactionText: string
  - Headings: H1: Interface: ITextData | H2: Properties | H3: redactionText | H3: redactionTextColor? | H3: redactionTextFontName? | H3: redactionTextSize? | H3: redactionTextStyle?

- [Interface: ITextSearch] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearch.htm): Represents a text search.
  - Second paragraph: next(): Promise<ITextSearchHit>
  - Headings: H1: Interface: ITextSearch | H2: Methods | H3: next()

- [Interface: ITextSearchHit] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchHit.htm): Search hit representing a found occurrence of the search term
  - Second paragraph: end: number
  - Headings: H1: Interface: ITextSearchHit | H2: Properties | H3: end | H3: start | H3: terms

- [Interface: ITextSearchOptions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchOptions.htm): Options to configure a text search
  - Second paragraph: optionalcaseSensitive: boolean
  - Headings: H1: Interface: ITextSearchOptions | H2: Properties | H3: caseSensitive? | H3: direction? | H3: normalizeAccentsForSearch? | H3: normalizeEmoji? | H3: searchMode? | H3: start? | H3: stemAll? | H3: stemmer?

- [Interface: ITextSearchTermHit] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchTermHit.htm): Search term hit representing the term that was found in a ITextSearchHit.
  - Second paragraph: end: number
  - Headings: H1: Interface: ITextSearchTermHit | H2: Properties | H3: end | H3: start | H3: term

- [Interface: ITextSearchUtilities] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchUtilities.htm): searchStaticText(text, searchTerm, options?): Promise<ITextSearch>
  - Second paragraph: • text: string | TextProvider
  - Headings: H1: Interface: ITextSearchUtilities | H2: Methods | H3: searchStaticText()

- [Interface: ITextUtilities] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextUtilities.htm): readonlysearch: ITextSearchUtilities
  - Headings: H1: Interface: ITextUtilities | H2: Properties | H3: search

- [Interface: IToolbar] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbar.htm): A dynamic toolbar that may contain multiple IToolbarControl types at runtime to generate toolbar actions
  - Second paragraph: readonlyallControls: IToolbarControl[]
  - Headings: H1: Interface: IToolbar | H2: Properties | H3: allControls | H3: centerControls | H3: class | H3: controlsHidden | H3: id | H3: leftControls | H3: overflow | H3: permissionCheck? | H3: rightControls | H3: title | H2: Methods | H3: addControl() | H3: createToolbarControl() | H3: disableAllControls() | H3: enableAllControls() | H3: getControlById() | H3: hideAllControls() | H3: removeControl() | H3: removeControlById() | H3: showAllControls() | H3: toggleList()

- [Interface: IToolbarButtonControlConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarButtonControlConfig.htm): Configuration object for defining new toolbar button control
  - Second paragraph: readonlyclass: string
  - Headings: H1: Interface: IToolbarButtonControlConfig | H2: Extends | H2: Properties | H3: class | H3: disable()? | H3: enable()? | H3: enableOnCreation? | H3: id | H3: imageUrl | H3: onClick() | H3: permissionCheck? | H3: title | H3: type

- [Interface: IToolbarControl] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarControl.htm): Base Type for a toolbar control that can be added to an IToolbar
  - Second paragraph: optionalariaLabel: string
  - Headings: H1: Interface: IToolbarControl | H2: Extended by | H2: Properties | H3: ariaLabel? | H3: class | H3: disabled | H3: id | H3: isControlCollection | H3: isFlexible | H3: isHidden | H3: order | H3: permissionCheck? | H3: role? | H3: scrollDimensions | H3: title | H3: viewModelPath | H2: Methods | H3: disable() | H3: enable() | H3: hide() | H3: show()

- [Interface: IToolbarControlConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarControlConfig.htm): Configuration object for defining new toolbar control
  - Second paragraph: readonlyclass: string
  - Headings: H1: Interface: IToolbarControlConfig | H2: Extended by | H2: Properties | H3: class | H3: disable()? | H3: enable()? | H3: enableOnCreation? | H3: id | H3: permissionCheck? | H3: title | H3: type

- [Interface: IToolbarControlsEnabledEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarControlsEnabledEvent.htm): Event data for the ViewerCollectionEventType.SkeletonShown event
  - Second paragraph: optionallongTextArtifactId: number
  - Headings: H1: Interface: IToolbarControlsEnabledEvent | H2: Properties | H3: longTextArtifactId? | H3: productionArtifactId? | H3: productionType? | H3: viewerType

- [Interface: IToolbarCustomControlConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarCustomControlConfig.htm): Configuration object for defining new toolbar custom control
  - Second paragraph: readonlyclass: string
  - Headings: H1: Interface: IToolbarCustomControlConfig | H2: Extends | H2: Properties | H3: class | H3: disable()? | H3: enable()? | H3: enableOnCreation? | H3: id | H3: innerHTML | H3: permissionCheck? | H3: title | H3: type

- [Interface: IToolbarOverflow] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarOverflow.htm): A toolbar control to group controls that no longer fit the space available in a toolbar
  - Second paragraph: readonlycenterControls: IToolbarControl[]
  - Headings: H1: Interface: IToolbarOverflow | H2: Properties | H3: centerControls | H3: combinedControls | H3: leftControls | H3: rightControls | H3: title | H3: visible

- [Interface: IToolbarRWCButtonControlConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarRWCButtonControlConfig.htm): Configuration object for defining new toolbar custom control
  - Second paragraph: readonlyclass: string
  - Headings: H1: Interface: IToolbarRWCButtonControlConfig | H2: Extends | H2: Properties | H3: class | H3: disable()? | H3: enable()? | H3: enableOnCreation? | H3: icon | H3: id | H3: onClick() | H3: permissionCheck? | H3: theme | H3: title | H3: type | H3: wrapperClass

- [Interface: IToolbarRWCToggleControlConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarRWCToggleControlConfig.htm): Configuration object for defining a new toolbar toggle button control
  - Second paragraph: readonlyactive: boolean
  - Headings: H1: Interface: IToolbarRWCToggleControlConfig | H2: Extends | H2: Properties | H3: active | H3: class | H3: disable()? | H3: enable()? | H3: enableOnCreation? | H3: icon | H3: id | H3: onClick() | H3: permissionCheck? | H3: title | H3: type

- [Interface: IToolbarService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarService.htm): Public toolbar service for toolbar customization
  - Second paragraph: allToolbars: IToolbar[]
  - Headings: H1: Interface: IToolbarService | H2: Properties | H3: allToolbars | H2: Methods | H3: createToolbarControl() | H3: getToolbarById()

- [Interface: IToolTipConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolTipConfig.htm): ToolTip configuration information
  - Second paragraph: toolTipContent: string
  - Headings: H1: Interface: IToolTipConfig | H2: Properties | H3: toolTipContent | H3: toolTipPosition

- [Interface: ITransientHighlightManagerApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITransientHighlightManagerApi.htm): Partial ITransientHighlightManager interface that defineds the highlighting API methods
  - Second paragraph: addHighlight(setId, target, highlightConfig?): Promise<HighlightMemento>
  - Headings: H1: Interface: ITransientHighlightManagerApi | H2: Remarks | H2: Extended by | H2: Methods | H3: addHighlight() | H3: addHighlightTooltip() | H3: addTerm() | H3: addTermWithContext() | H3: createSet() | H3: deselectAllAnnotations() | H3: disableAutoHighlight() | H3: doesSetExist() | H3: enableAutoHighlight() | H3: getSelectedAnnotations() | H3: goToFirst() | H3: goToHighlight() | H3: goToLast() | H3: goToNext() | H3: goToPrev() | H3: highlightTerm() | H3: highlightTermWithContext() | H3: removeHighlight() | H3: removeHighlightSet() | H3: removeHighlightTooltip() | H3: selectAnnotation() | H3: serialize() | H3: setHighlightSetVisibility() | H3: setHighlightVisibility() | H3: toggleHighlightSetVisibility() | H3: toggleHighlightVisibility()

- [Interface: ITransientHighlightManagerEventApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITransientHighlightManagerEventApi.htm): Partial ITransientHighlightManager interface that defineds the event handler API methods
  - Second paragraph: offadd(setId, addCallback, refObject?): void
  - Headings: H1: Interface: ITransientHighlightManagerEventApi | H2: Remarks | H2: Methods | H3: offadd() | H3: offclick() | H3: offdone() | H3: offHighlightActiveChange() | H3: offHighlightVisibilityChange() | H3: offmove() | H3: offremove() | H3: onadd() | H3: onclick() | H3: ondone() | H3: onHighlightActiveChange() | H3: onHighlightVisibilityChange() | H3: onmove() | H3: onremove()

- [Interface: IUpdateApprovedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUpdateApprovedEvent.htm): Event data for the QueuePointerEventType.UpdateApproved event
  - Second paragraph: currentIndex: number
  - Headings: H1: Interface: IUpdateApprovedEvent | H2: Properties | H3: currentIndex | H3: currentLongTextArtifactId? | H3: currentProductionArtifactId? | H3: currentProductionType? | H3: currentType | H3: id | H3: targetIndex | H3: targetLongTextArtifactId? | H3: targetProductionArtifactId? | H3: targetProductionType? | H3: targetType

- [Interface: IUpdatedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUpdatedEvent.htm): Event data for the QueuePointerEventType.Updated event
  - Second paragraph: currentIndex: number
  - Headings: H1: Interface: IUpdatedEvent | H2: Properties | H3: currentIndex | H3: currentLongTextArtifactId? | H3: currentProductionArtifactId? | H3: currentProductionType? | H3: currentType | H3: id | H3: previousIndex | H3: previousLongTextArtifactId? | H3: previousProductionArtifactId? | H3: previousProductionType? | H3: previousType

- [Interface: IUpdateRequestedEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUpdateRequestedEvent.htm): Event data for the QueuePointerEventType.UpdateRequested event
  - Second paragraph: optionalchangePointer: boolean
  - Headings: H1: Interface: IUpdateRequestedEvent | H2: Properties | H3: changePointer? | H3: currentIndex | H3: currentLongTextArtifactId? | H3: currentProductionArtifactId? | H3: currentProductionType? | H3: currentType | H3: targetIndex | H3: targetLongTextArtifactId? | H3: targetProductionArtifactId? | H3: targetProductionType? | H3: targetType

- [Interface: IUserPreferencesApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUserPreferencesApi.htm): The User Preferences API is designed to allow integration tests to explicitly persist the preferences into storage
  - Second paragraph: save(): Promise<void>
  - Headings: H1: Interface: IUserPreferencesApi | H2: Methods | H3: save()

- [Interface: IUtilitiesApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUtilitiesApi.htm): Helpful Utilities
  - Second paragraph: readonlytext: ITextUtilities
  - Headings: H1: Interface: IUtilitiesApi | H2: Properties | H3: text | H2: Methods | H3: exportToCsv() | H3: getCache() | H3: getHttpClient()

- [Interface: IVersionInformation] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IVersionInformation.htm): Application version information
  - Second paragraph: readonlybuildType: string
  - Headings: H1: Interface: IVersionInformation | H2: Properties | H3: buildType | H3: oiVersion | H3: version

- [Interface: IViewerCard] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCard.htm): Card that is used for displaying queue items
  - Second paragraph: readonlyactive: boolean
  - Headings: H1: Interface: IViewerCard | H2: Extends | H2: Properties | H3: active | H3: activeFlag | H3: applicationWindow | H3: autoRestore | H3: bottomToolbar? | H3: cardError | H3: config | H3: defaultHeight? | H3: defaultWidth? | H3: dockSkeletonClassName | H3: element? | H3: enabled | H3: errorString? | H3: frame? | H3: hasError | H3: hasNotification | H3: height? | H3: icon | H3: id | H3: instance | H3: instanceId | H3: instanceIndex | H3: leftToolbar? | H3: loadDeferred | H3: location? | H3: maximized | H3: minHeight | H3: minWidth | H3: order | H3: overlay? | H3: parameters? | H3: popoutInProgress | H3: poppedIn | H3: poppedOut | H3: rightToolbar? | H3: skeletonVisible | H3: status | H3: title | H3: toolbars? | H3: topToolbar? | H3: viewerCollection | H3: viewerTab | H3: viewerToolbar? | H3: viewerType | H3: visible | H3: width? | H3: window | H2: Methods | H3: activate() | H3: bindInstance() | H3: canDeactivate() | H3: completeFrameLoad() | H3: createBanner() | H3: createHtmlBanner() | H3: createToolbar() | H3: deactivate() | H3: disable() | H3: dismissBanner() | H3: dismissBannerByClass() | H3: enable() | H3: failFrameLoad() | H3: hideOverlay() | H3: hideSkeleton() | H3: load() | H3: maximize() | H3: move() | H3: popin() | H3: popout() | H3: remove() | H3: reportError() | H3: restore() | H3: resumeMinHeight() | H3: setActiveFlag() | H3: setStatus() | H3: showNotificationDot() | H3: showOverlay() | H3: showSkeleton() | H3: stateChanged() | H3: suspendMinHeight() | H3: unload() | H3: updateLayout() | H3: waitForDetachment()

- [Interface: IViewerCardConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCardConfig.htm): Configuration object for defining new viewer cards
  - Second paragraph: optionalappGuid: string
  - Headings: H1: Interface: IViewerCardConfig | H2: Extends | H2: Properties | H3: appGuid? | H3: appVersion? | H3: autoRestore? | H3: category? | H3: categoryOrder? | H3: defaultHeight? | H3: defaultWidth? | H3: extends? | H3: icon? | H3: id | H3: loader | H3: location? | H3: minHeight? | H3: minWidth? | H3: order? | H3: overrideViewerType? | H3: singleton? | H3: skeleton? | H3: supportsPopout? | H3: title | H3: toolbarsConfig? | H3: toolTipConfig? | H3: viewerToolbarConfig? | H3: viewerType | H2: Methods | H3: createInstance() | H3: supportsItem()

- [Interface: IViewerCardInstance] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCardInstance.htm): Viewer card instance information
  - Second paragraph: optionalcardActivated: (api, card) => void
  - Headings: H1: Interface: IViewerCardInstance | H2: Extends | H2: Extended by | H2: Properties | H3: cardActivated()? | H3: cardBuildTabOptions()? | H3: cardBuildToolbarOptions()? | H3: cardCanDeactivate()? | H3: cardCreateUnsupportedOverlayCard()? | H3: cardDeactivated()? | H3: cardError()? | H3: cardLoaded()? | H3: cardLoadState()? | H3: cardMaximized()? | H3: cardResized()? | H3: cardRestored()? | H3: cardSaveState()? | H3: cardUnloaded()? | H3: id | H3: type | H3: unsupportedTabTitle? | H2: Methods | H3: cardLoadItem()

- [Interface: IViewerCardTabOption] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCardTabOption.htm): Describes a viewer card tab option that is displayed for a viewer card
  - Second paragraph: action: () => boolean | Promise<boolean>
  - Headings: H1: Interface: IViewerCardTabOption | H2: Properties | H3: action() | H3: id | H3: selected? | H3: title

- [Interface: IViewerChoice] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerChoice.htm): Class representing a ViewerType option for a given IViewerCollection
  - Second paragraph: action: () => void
  - Headings: H1: Interface: IViewerChoice | H2: Properties | H3: action() | H3: isEnabled | H3: isVisible | H3: label | H3: viewerType

- [Interface: IViewerCollection] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCollection.htm): A collection of IViewerCardInstances
  - Second paragraph: readonlyactiveType: string
  - Headings: H1: Interface: IViewerCollection | H2: Extends | H2: Properties | H3: activeType | H3: activeViewer | H3: bottomToolbar | H3: card | H3: codingCards? | H3: contentHighlighting | H3: contentType | H3: currentDocumentMetric | H3: hasActiveViewer | H3: id | H3: isBootstrapped | H3: isNavigating | H3: leftToolbar | H3: pageLayout | H3: queuePointer | H3: queuePointerStack | H3: rightToolbar | H3: supportedViewerTypes | H3: zoom | H2: Methods | H3: getDockLocation() | H3: getPublicDocumentData() | H3: getViewer() | H3: getViewerCard() | H3: off() | H3: on() | H3: once() | H3: popQueuePointer() | H3: reload() | H3: setQueuePointer() | H3: switchToQueuePointerById() | H3: switchToQueuePointerByIndex()

- [Interface: IViewerCollectionPageLayoutApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCollectionPageLayoutApi.htm): Page Layout API for a IViewerCollection
  - Second paragraph: This class synchronizes page layout mode across all IViewerCardInstances in the collection that support this feature.
  - Headings: H1: Interface: IViewerCollectionPageLayoutApi | H2: Properties | H3: mode | H2: Methods | H3: buildPageLayoutModeControls()

- [Interface: IViewerCollectionZoomApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCollectionZoomApi.htm): Zoom API for a IViewerCollection
  - Second paragraph: This class synchronizes zoom across all zoom-enabled IViewerCardInstances in the collection.
  - Headings: H1: Interface: IViewerCollectionZoomApi | H2: Properties | H3: level | H3: mode | H2: Methods | H3: buildZoomControls() | H3: buildZoomFitControls() | H3: updateZoom()

- [Interface: IViewerContentKeyCacheManager] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerContentKeyCacheManager.htm): Class for managing the cached viewer content keys
  - Second paragraph: tryClearCacheForDocumentAndType(documentArtifactId, viewerType, productionArtifactId?, fileId?, productionType?): any
  - Headings: H1: Interface: IViewerContentKeyCacheManager | H2: Methods | H3: tryClearCacheForDocumentAndType() | H3: tryClearCacheForQueueItemAndType()

- [Interface: IViewerHighlightManager] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerHighlightManager.htm): Class for handling persistent highlights for a viewer
  - Second paragraph: activeSearch: IViewerSearch
  - Headings: H1: Interface: IViewerHighlightManager | H2: Properties | H3: activeSearch | H2: Methods | H3: addTerms() | H3: changeSetExpanded() | H3: changeSetVisibility() | H3: changeTermVisibility() | H3: cleanupPersistentHighlights() | H3: clearRecentSearchSet() | H3: clearRecentSearchTerm() | H3: clearSearch() | H3: findFirstSearchTerm() | H3: findNextSearchTerm() | H3: findPreviousSearchTerm() | H3: navigateToNextHighlight() | H3: navigateToPrevHighlight() | H3: refresh() | H3: selectSet() | H3: selectTerm() | H3: toggleDrawer() | H3: unselectAll()

- [Interface: IViewerMenu] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerMenu.htm): API for working with the viewer menu for an IViewerCollection
  - Second paragraph: readonlyviewerChoices: IViewerChoice[]
  - Headings: H1: Interface: IViewerMenu | H2: Properties | H3: viewerChoices

- [Interface: IViewerObjects] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerObjects.htm): Collection of objects found in viewer content at a specific set of coordinates
  - Second paragraph: readonlyoptionaldesignations: IDesignation[]
  - Headings: H1: Interface: IViewerObjects | H2: Properties | H3: designations? | H3: highlights? | H3: hyperlinks? | H3: selection?

- [Interface: IViewerSearch] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerSearch.htm): hasResults: boolean
  - Second paragraph: Indicates if instances of the search term are found in the document
  - Headings: H1: Interface: IViewerSearch | H2: Properties | H3: hasResults | H3: searchTerm

- [Interface: IViewerService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerService.htm): Entity for managing IViewerCollections
  - Second paragraph: readonlycount: number
  - Headings: H1: Interface: IViewerService | H2: Extends | H2: Properties | H3: count | H3: mainCollection | H2: Methods | H3: get() | H3: off() | H3: on() | H3: once() | H3: remove()

- [Interface: IViewerSettingsService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerSettingsService.htm): Class for working with Viewer Settings Card and holding the viewer setting service methods
  - Second paragraph: hide(): Promise<void>
  - Headings: H1: Interface: IViewerSettingsService | H2: Methods | H3: hide() | H3: show()

- [Interface: IViewModelCardLoader] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewModelCardLoader.htm): Configuration for Aurelia View/ViewModel cards
  - Second paragraph: optionalautoResolveLoad: boolean
  - Headings: H1: Interface: IViewModelCardLoader | H2: Properties | H3: autoResolveLoad? | H3: viewModelPath? | H3: viewPath?

- [Interface: IWindowService] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IWindowService.htm): Window API to create and manage IApplicationWindows.
  - Second paragraph: readonlyall: IApplicationWindow[]
  - Headings: H1: Interface: IWindowService | H2: Properties | H3: all | H3: main | H3: relativity | H2: Methods | H3: closeAll() | H3: create() | H3: getWindow()

- [Interface: IZoomApi] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IZoomApi.htm): API for interacting with the zoom level of a IViewerCardInstance
  - Second paragraph: resetZoom(): number
  - Headings: H1: Interface: IZoomApi | H2: Methods | H3: resetZoom() | H3: zoomIn() | H3: zoomLevel() | H3: zoomOut() | H3: zoomToFit() | H3: zoomToIndex()

- [Interface: IZoomControlCollection] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IZoomControlCollection.htm): Special IControlCollection for zoom controls
  - Second paragraph: optionalariaLabel: string
  - Headings: H1: Interface: IZoomControlCollection | H2: Extends | H2: Properties | H3: ariaLabel? | H3: class | H3: controls | H3: disabled | H3: id | H3: isControlCollection | H3: isFlexible | H3: isHidden | H3: leftDivider | H3: order | H3: permissionCheck? | H3: rightDivider | H3: role? | H3: scrollDimensions | H3: title | H3: viewModelPath | H2: Methods | H3: addControl() | H3: addZoomControl() | H3: disable() | H3: enable() | H3: getControlById() | H3: hide() | H3: removeControl() | H3: removeZoomControl() | H3: setZoomLevel() | H3: show()

- [Interface: IZoomEvent] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IZoomEvent.htm): Event data for the RelativityViewerEventType.Zoom event
  - Second paragraph: zoomIndex: number
  - Headings: H1: Interface: IZoomEvent | H2: Properties | H3: zoomIndex | H3: zoomMode

- [Interface: LineRangeMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_LineRangeMemento.htm): endLineIndex: number
  - Second paragraph: The 0-based index of the last line to include in the range from the last page (inclusive)
  - Headings: H1: Interface: LineRangeMemento | H2: Properties | H3: endLineIndex | H3: endOffset | H3: endPageIndex | H3: startLineIndex | H3: startOffset | H3: startPageIndex | H3: type

- [Interface: LinkOption] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_LinkOption.htm): Configuration for a link to be displayed in a notification banner
  - Second paragraph: optionallinkClass: string
  - Headings: H1: Interface: LinkOption | H2: Properties | H3: linkClass? | H3: linkText | H3: onClick()

- [Interface: RectangleOffsets] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_RectangleOffsets.htm): readonlybottom: number
  - Second paragraph: readonlyleft: number
  - Headings: H1: Interface: RectangleOffsets | H2: Properties | H3: bottom | H3: left | H3: right | H3: top

- [Interface: RectRangeMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_RectRangeMemento.htm): bottom: number
  - Second paragraph: The bottom edge of the rectangular range
  - Headings: H1: Interface: RectRangeMemento | H2: Properties | H3: bottom | H3: embedId? | H3: hdpi? | H3: left | H3: page | H3: right | H3: section? | H3: top | H3: type | H3: units | H3: vdpi?

- [Interface: SetGroupMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_SetGroupMemento.htm): Memento object representing a content highlighting highlight set group
  - Second paragraph: readonlyid: string
  - Headings: H1: Interface: SetGroupMemento | H2: Properties | H3: id | H3: sets | H3: visibilityPersistenceMode | H3: visible

- [Interface: TextRangeMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextRangeMemento.htm): acc: number
  - Second paragraph: The first character of the ACC range (inclusive)
  - Headings: H1: Interface: TextRangeMemento | H2: Properties | H3: acc | H3: accend | H3: type

- [Interface: TextSearchConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchConfig.htm): Configuration for text searches
  - Second paragraph: caseSensitive: boolean
  - Headings: H1: Interface: TextSearchConfig | H2: Extended by | H2: Properties | H3: caseSensitive | H3: normalizeAccentsForSearch | H3: normalizeEmoji | H3: searchMode | H3: stemAll | H3: stemmer

- [Interface: TextSearchResult] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchResult.htm): range: TextRangeMemento
  - Second paragraph: optionalselected: boolean
  - Headings: H1: Interface: TextSearchResult | H2: Properties | H3: range | H3: selected? | H3: terms?

- [Interface: TextSearchResultTerm] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchResultTerm.htm): range: TextRangeMemento
  - Second paragraph: term: string
  - Headings: H1: Interface: TextSearchResultTerm | H2: Properties | H3: range | H3: term

- [Interface: TextSearchTerm] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchTerm.htm): Configuration for term text searches
  - Second paragraph: caseSensitive: boolean
  - Headings: H1: Interface: TextSearchTerm | H2: Extends | H2: Properties | H3: caseSensitive | H3: context? | H3: normalizeAccentsForSearch | H3: normalizeEmoji | H3: searchMode | H3: stemAll | H3: stemmer | H3: term | H3: termMetadata?

- [Interface: TimeRangeMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TimeRangeMemento.htm): begin: number
  - Second paragraph: The 0-based timestamp (in ms) the range begins at
  - Headings: H1: Interface: TimeRangeMemento | H2: Properties | H3: begin | H3: end | H3: page | H3: type

- [Interface: TooltipMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TooltipMemento.htm): _oiTooltip: Tooltip
  - Second paragraph: The original tooltip object returned from calling addTooltip on the OI highlight
  - Headings: H1: Interface: TooltipMemento | H2: Properties | H3: _oiTooltip | H3: icon? | H3: text

- [Interface: UserDataMap] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_UserDataMap.htm): [key: string]: any
  - Headings: H1: Interface: UserDataMap | H2: Indexable

- [Internal] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Internal.htm)
  - Headings: H1: Internal | H2: Index | H3: Interfaces

- [ItemList] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ItemList.htm)
  - Headings: H1: ItemList | H2: Index | H3: Interfaces | H3: Type Aliases

- [KeyboardShortcuts] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/KeyboardShortcuts.htm)
  - Headings: H1: KeyboardShortcuts | H2: Index | H3: Enumerations | H3: Interfaces

- [Lifecycle] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Lifecycle.htm)
  - Headings: H1: Lifecycle | H2: Index | H3: Enumerations | H3: Interfaces

- [Loading Queue Items] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Loading_Queue_Items.htm): The viewer collection invokes the IViewerCardInstance.cardLoadItem method when a viewer type should load a new queue item. This page describes how to call this method, and handle cancellations and errors.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Loading Queue Items | H2: Parameters for cardLoadItem method | H3: item | H3: options | H2: Handle a cancellation | H2: Handle errors

- [MassOperations] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/MassOperations.htm)
  - Headings: H1: MassOperations | H2: Index | H3: Interfaces

- [Migrating Legacy Integrations] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Migrating_Legacy_Integrations.htm): Use the information on this page to learn about migrating to the Relativity Review Interface application.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Migrating Legacy Integrations | H2: Legacy integrations | H2: Support for legacy HTML5 document viewer

- [Migration Guide] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Migration_Guide.htm): Use this guide to learn about migrating common integrations from the legacy HTML5 document viewer to the new Relativity Review Interface.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Migration Guide | H2: Custom panes | H3: Sample legacy custom pane | H3: Sample migrated custom pane | H3: Map legacy values to a custom card | H2: Custom viewers | H2: Context menu integrations | H2: Document layout changes

- [Navigation In Relativity Review Interface] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Navigation_In_Relativity_Review_Interface.htm): In the Review Interface, queues represent an ordered list of items that users can navigate through in the document viewer. This queue is frequently referred to as the review queue, which contains queue items that can be added or removed.
  - Second paragraph: The Relativity Review Interface exposes a set of APIs that you can use to implement document navigation functionality in the viewer through the use of queues.
  - Headings: H1: Navigation In Relativity Review Interface | H2: APIs for queues | H2: Queue items | H2: Creating queues | H2: Deleting queues | H2: Modifying queues | H2: Adding custom data to queues | H2: Queue events | H2: Queue pointers | H3: Sample queue use case | H3: Code samples for the queue pointer object

- [Note] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Note.htm)
  - Headings: H1: Note | H2: Index | H3: Interfaces | H3: Type Aliases

- [Notification] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Notification.htm)
  - Headings: H1: Notification | H2: Index | H3: Enumerations | H3: Interfaces | H3: Type Aliases

- [Performance] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Performance.htm)
  - Headings: H1: Performance | H2: Index | H3: Interfaces | H3: Type Aliases

- [Permissions] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Permissions.htm)
  - Headings: H1: Permissions | H2: Index | H3: Interfaces

- [Preview] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Preview.htm)
  - Headings: H1: Preview | H2: Index | H3: Enumerations | H3: Interfaces

- [ProductionHistory] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ProductionHistory.htm)
  - Headings: H1: ProductionHistory | H2: Index | H3: Interfaces

- [Queue] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Queue.htm)
  - Headings: H1: Queue | H2: Index | H3: Enumerations | H3: Interfaces | H3: Type Aliases

- [range-memento-helper/range-memento-helper-interface] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/range-memento-helperrange-memento-helper-interface.htm)
  - Headings: H1: range-memento-helper/range-memento-helper-interface | H2: Index | H3: Interfaces

- [Redirecting Relativity Viewers] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Redirecting_Relativity_Viewers.htm): You can redirect Relativity viewers to display different content. The Review Interface includes the Item Load Transform feature, which allows an extension to modify the content that a viewer displays.
  - Second paragraph: The Review Extensions define IItemLoadTransform objects, including an ItemLoadTransformFn object. This object determines how the viewer is redirected. Use this feature to display an RDO file or a different document in an existing Relativity viewer.
  - Headings: H1: Redirecting Relativity Viewers

- [RelatedItems] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/RelatedItems.htm)
  - Headings: H1: RelatedItems | H2: Index | H3: Interfaces

- [Relativity Review API] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Relativity_Review_API_Introduction.htm): The Review API is a suite of APIs that you can use to build and maintain Review integrations. Review is an updated Relativity document review application that you can use to review, annotate, and code documents in a workspace. It offers performance and extensibility improvements over the legacy HTML viewer.
  - Second paragraph: The API supports the extensibility of Review by providing JavaScript classes and functions with the following features:
  - Headings: H1: Relativity Review API | H2: Modules

- [Relativity Review API Reference] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Review_API_Reference.htm)
  - Headings: H1: Relativity Review API Reference | H2: Modules

- [Relativity Review overview] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Relativity_Review_overview.htm): Relativity Review is a document review application that you can use to review, annotate, and code documents in a workspace. It offers performance and extensibility improvements over the current HTML viewer.
  - Second paragraph: Beginning with Relativity 10.2 Foxglove, Relativity Review supports a full review platform. It currently powers only the image and production viewers within the existing document viewer.
  - Headings: H1: Relativity Review overview | H2: Relativity Review API suite | H2: Enable or disable Relativity Review

- [Sample Viewer Type] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Sample_Viewer_Type.htm): The following code sample illustrates an extension that registers a simple custom viewer type:
  - Headings: H1: Sample Viewer Type

- [Search] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Search.htm)
  - Headings: H1: Search | H2: Index | H3: Interfaces

- [Settings] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Settings.htm)
  - Headings: H1: Settings | H2: Index | H3: Interfaces

- [SmartHighlights] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/SmartHighlights.htm)
  - Headings: H1: SmartHighlights | H2: Index | H3: Interfaces

- [Toolbar] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Toolbar.htm)
  - Headings: H1: Toolbar | H2: Index | H3: Enumerations | H3: Interfaces

- [Toolbars] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Toolbars.htm): In the Review Interface, the toolbar contains the buttons and icons that users click to perform actions in the document viewer. For example, the Review Interface contains a toolbar with page navigation, redaction, and zoom buttons.
  - Second paragraph: The viewer configuration determines whether the Review Interface has multiple or no toolbars displayed. You can customize this configuration using the Review API or extension scripts.
  - Headings: H1: Toolbars | H2: Create toolbar controls using the Review API | H2: Create toolbar controls in extension scripts | H3: Resolving image URLs for CDN-delivered extensions | H3: Control types | H3: TypeScript example (recommended: rwcbutton) | H3: Toggle button example (rwctogglebutton) | H3: Viewer-type-specific controls

- [ToolTip] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ToolTip.htm)
  - Headings: H1: ToolTip | H2: Index | H3: Enumerations | H3: Interfaces

- [Transient Highlights] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Transient_Highlights.htm): You can use the Transient Highlighting API (ITransientHighlightManager) to create transient highlights and annotations, which the Review Interface doesn't persist. This API supports translating these highlights to and from objects that persist them outside of the Review Interface. The core viewers in the Review Interface expose this API and additional utility methods. Custom viewers may not expose this API.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Transient Highlights | H2: Code samples | H2: Highlight sets | H2: Highlights | H3: Create a range | H3: Retrieve the page height and width | H3: Define a highlight config object | H3: Create a highlight | H3: Delete a highlight | H2: Interact with highlights | H3: Set the selection mode | H3: Select ranges | H3: Retrieve highlights | H2: Draw highlights | H2: Highlight events

- [Type Alias: AnnotationLocation] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_AnnotationLocation.htm): AnnotationLocation: "fullpage" | IAnnotationRectangle
  - Second paragraph: Location data about an IAnnotation
  - Headings: H1: Type Alias: AnnotationLocation

- [Type Alias: AnnotationSubType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_AnnotationSubType.htm): AnnotationSubType: HighlightSubType | RedactionSubType
  - Second paragraph: IAnnotation Sub-Type
  - Headings: H1: Type Alias: AnnotationSubType

- [Type Alias: ApmCustomData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ApmCustomData.htm): ApmCustomData: string | number | boolean | Date
  - Second paragraph: Data types supported by the APM framework
  - Headings: H1: Type Alias: ApmCustomData

- [Type Alias: ContentHighlightingApiCustomEventHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiCustomEventHandler__.htm): ContentHighlightingApiCustomEventHandler: (event?) => void
  - Second paragraph: Event handler for the custom IContentHighlightingApi events.
  - Headings: H1: Type Alias: ContentHighlightingApiCustomEventHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiHighlightActiveChangeHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightActiveChangeHandler__.htm): ContentHighlightingApiHighlightActiveChangeHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onhighlightactivechange event.
  - Headings: H1: Type Alias: ContentHighlightingApiHighlightActiveChangeHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiHighlightAddHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightAddHandler__.htm): ContentHighlightingApiHighlightAddHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onhighlightadd event.
  - Headings: H1: Type Alias: ContentHighlightingApiHighlightAddHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiHighlightClickHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightClickHandler__.htm): ContentHighlightingApiHighlightClickHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onhighlightclick event.
  - Headings: H1: Type Alias: ContentHighlightingApiHighlightClickHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiHighlightMoveHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightMoveHandler__.htm): ContentHighlightingApiHighlightMoveHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onhighlightmove event.
  - Headings: H1: Type Alias: ContentHighlightingApiHighlightMoveHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiHighlightRemoveHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightRemoveHandler__.htm): ContentHighlightingApiHighlightRemoveHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onhighlightremove event.
  - Headings: H1: Type Alias: ContentHighlightingApiHighlightRemoveHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiSearchCompleteHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSearchCompleteHandler__.htm): ContentHighlightingApiSearchCompleteHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onsearchcomplete event.
  - Headings: H1: Type Alias: ContentHighlightingApiSearchCompleteHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiSearchHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSearchHandler__.htm): ContentHighlightingApiSearchHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onsearch event.
  - Headings: H1: Type Alias: ContentHighlightingApiSearchHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiSetAddHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSetAddHandler__.htm): ContentHighlightingApiSetAddHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onsetadd event.
  - Headings: H1: Type Alias: ContentHighlightingApiSetAddHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiSetRemoveHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSetRemoveHandler__.htm): ContentHighlightingApiSetRemoveHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onsetremove event.
  - Headings: H1: Type Alias: ContentHighlightingApiSetRemoveHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiSetVisibleChangeHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSetVisibleChangeHandler__.htm): ContentHighlightingApiSetVisibleChangeHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onsetvisiblechange event.
  - Headings: H1: Type Alias: ContentHighlightingApiSetVisibleChangeHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingApiVisibleChangeHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiVisibleChangeHandler__.htm): ContentHighlightingApiVisibleChangeHandler: (event) => void
  - Second paragraph: Event handler for the IContentHighlightingApi.onvisiblechange event.
  - Headings: H1: Type Alias: ContentHighlightingApiVisibleChangeHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingCardApiContentChangeHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiContentChangeHandler__.htm): ContentHighlightingCardApiContentChangeHandler: (event) => void
  - Second paragraph: Event handler method signature for the ContentHighlightingCardApiEvent.ContentChange event
  - Headings: H1: Type Alias: ContentHighlightingCardApiContentChangeHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingCardApiRenderAbortHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderAbortHandler__.htm): ContentHighlightingCardApiRenderAbortHandler: (event) => void
  - Second paragraph: Event handler method signature for the ContentHighlightingCardApiEvent.RenderAbort event
  - Headings: H1: Type Alias: ContentHighlightingCardApiRenderAbortHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingCardApiRenderCompleteHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderCompleteHandler__.htm): ContentHighlightingCardApiRenderCompleteHandler: (event) => void
  - Second paragraph: Event handler method signature for the ContentHighlightingCardApiEvent.RenderComplete event
  - Headings: H1: Type Alias: ContentHighlightingCardApiRenderCompleteHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingCardApiRenderErrorHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderErrorHandler__.htm): ContentHighlightingCardApiRenderErrorHandler: (event) => void
  - Second paragraph: Event handler method signature for the ContentHighlightingCardApiEvent.RenderError event
  - Headings: H1: Type Alias: ContentHighlightingCardApiRenderErrorHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingCardApiRenderHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderHandler__.htm): ContentHighlightingCardApiRenderHandler: (event) => void
  - Second paragraph: Event handler method signature for the ContentHighlightingCardApiEvent.Render event
  - Headings: H1: Type Alias: ContentHighlightingCardApiRenderHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingCardApiVisibleChangeHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiVisibleChangeHandler__.htm): ContentHighlightingCardApiVisibleChangeHandler: (event) => void
  - Second paragraph: Event handler method signature for the ContentHighlightingCardApiEvent.VisibleChange event
  - Headings: H1: Type Alias: ContentHighlightingCardApiVisibleChangeHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingCardVisibleFn()<CType, CTType>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardVisibleFn__CType__CTType.htm): ContentHighlightingCardVisibleFn<CType, CTType>: (params) => boolean
  - Second paragraph: Function to be called by the Content Highlighting Framework to determine whether a content highlighting card should be visible or hidden
  - Headings: H1: Type Alias: ContentHighlightingCardVisibleFn()<CType, CTType> | H2: Type Parameters | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingServiceEnabledChangeHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingServiceEnabledChangeHandler__.htm): ContentHighlightingServiceEnabledChangeHandler: (event) => void
  - Second paragraph: Event handler method signature for the ContentHighlightingServiceEvent.EnabledChange event
  - Headings: H1: Type Alias: ContentHighlightingServiceEnabledChangeHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingServiceFeatureEnabledChangeHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingServiceFeatureEnabledChangeHandler__.htm): ContentHighlightingServiceFeatureEnabledChangeHandler: (event) => void
  - Second paragraph: Event handler method signature for the ContentHighlightingServiceEvent.FeatureEnabledChange event
  - Headings: H1: Type Alias: ContentHighlightingServiceFeatureEnabledChangeHandler() | H2: Parameters | H2: Returns

- [Type Alias: ContentHighlightingServiceFeatureRegisteredHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingServiceFeatureRegisteredHandler__.htm): ContentHighlightingServiceFeatureRegisteredHandler: (event) => void
  - Second paragraph: Event handler method signature for the ContentHighlightingServiceEvent.FeatureRegistered event
  - Headings: H1: Type Alias: ContentHighlightingServiceFeatureRegisteredHandler() | H2: Parameters | H2: Returns

- [Type Alias: CustomData] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_CustomData.htm): CustomData: string | number | boolean | Date
  - Second paragraph: Serializable custom data used for context on an object
  - Headings: H1: Type Alias: CustomData

- [Type Alias: EventHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_EventHandler__.htm): EventHandler: (...args) => any
  - Second paragraph: Generic event handler function type
  - Headings: H1: Type Alias: EventHandler() | H2: Parameters | H2: Returns

- [Type Alias: FeatureConfigValue] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_FeatureConfigValue.htm): FeatureConfigValue: boolean | [boolean, object] | undefined | null
  - Headings: H1: Type Alias: FeatureConfigValue

- [Type Alias: FontSizeOrAuto] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_FontSizeOrAuto.htm): FontSizeOrAuto: FontSize | number | "auto"
  - Headings: H1: Type Alias: FontSizeOrAuto

- [Type Alias: HyperlinkRangeMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_HyperlinkRangeMemento.htm): HyperlinkRangeMemento: TextRangeMemento | LineRangeMemento
  - Second paragraph: The range for a IHyperlink
  - Headings: H1: Type Alias: HyperlinkRangeMemento

- [Type Alias: ICardCustomState] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ICardCustomState.htm): ICardCustomState: object
  - Second paragraph: [key: string]: string | number | boolean | null | undefined
  - Headings: H1: Type Alias: ICardCustomState | H2: Index Signature

- [Type Alias: IDesignation] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IDesignation.htm): IDesignation: INote<NoteType.designation>
  - Headings: H1: Type Alias: IDesignation

- [Type Alias: IHyperlinkManager] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IHyperlinkManager.htm): IHyperlinkManager: IHyperlinkManagerApi & IHyperlinkManagerEventApi
  - Headings: H1: Type Alias: IHyperlinkManager

- [Type Alias: INoteManager] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_INoteManager.htm): INoteManager: INoteManagerApi & INoteManagerEventApi
  - Headings: H1: Type Alias: INoteManager

- [Type Alias: IReadonlyCardConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IReadonlyCardConfig.htm): IReadonlyCardConfig: { readonly [P in keyof ICardConfig]: ICardConfig[P] }
  - Second paragraph: Configuration object for defining new cards
  - Headings: H1: Type Alias: IReadonlyCardConfig

- [Type Alias: IReadonlyCardIcon] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IReadonlyCardIcon.htm): IReadonlyCardIcon: { readonly [P in keyof ICardIcon]: ICardIcon[P] }
  - Second paragraph: Read-only card icon definition
  - Headings: H1: Type Alias: IReadonlyCardIcon

- [Type Alias: IReadonlyViewerCardConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IReadonlyViewerCardConfig.htm): IReadonlyViewerCardConfig: { readonly [P in keyof IViewerCardConfig]: IViewerCardConfig[P] }
  - Second paragraph: Configuration object for defining new viewer cards
  - Headings: H1: Type Alias: IReadonlyViewerCardConfig

- [Type Alias: ItemListFieldValueTransformFn()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ItemListFieldValueTransformFn__.htm): ItemListFieldValueTransformFn: (content, dataItem) => any
  - Second paragraph: Function used to transform an item list column into a different item before it is loaded into a viewer card instance
  - Headings: H1: Type Alias: ItemListFieldValueTransformFn() | H2: Parameters | H2: Returns

- [Type Alias: ItemListFieldValueTransformIdentificationFn()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ItemListFieldValueTransformIdentificationFn__.htm): ItemListFieldValueTransformIdentificationFn: (api) => Promise<number[]>
  - Second paragraph: Function used to retrieve the list of field artifact IDs the field value transform will be applied to
  - Headings: H1: Type Alias: ItemListFieldValueTransformIdentificationFn() | H2: Parameters | H2: Returns

- [Type Alias: ItemLoadTransformFn()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ItemLoadTransformFn__.htm): ItemLoadTransformFn: (api, viewerCard, item, options, performanceWorkflow?, documentMetric?) => IItemLoadTransformResult | Promise<IItemLoadTransformResult>
  - Second paragraph: Function used to transform a IQueueItem into a different item before it is loaded into a viewer card instance
  - Headings: H1: Type Alias: ItemLoadTransformFn() | H2: Parameters | H2: Returns

- [Type Alias: ITransientHighlightManager] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ITransientHighlightManager.htm): ITransientHighlightManager: ITransientHighlightManagerApi & ITransientHighlightManagerEventApi
  - Second paragraph: Provides a way to add/remove highlight sets and terms from the viewer with no persistence
  - Headings: H1: Type Alias: ITransientHighlightManager | H2: Remarks

- [Type Alias: NoteRangeMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_NoteRangeMemento.htm): NoteRangeMemento: TextRangeMemento | LineRangeMemento
  - Second paragraph: The range memento for a INote
  - Headings: H1: Type Alias: NoteRangeMemento

- [Type Alias: PartialHighlightConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PartialHighlightConfig.htm): PartialHighlightConfig: { [P in keyof HighlightConfig]?: HighlightConfig[P] }
  - Headings: H1: Type Alias: PartialHighlightConfig

- [Type Alias: PartialTextSearchConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PartialTextSearchConfig.htm): PartialTextSearchConfig: { [P in keyof TextSearchConfig]?: TextSearchConfig[P] }
  - Headings: H1: Type Alias: PartialTextSearchConfig

- [Type Alias: PopupFactoryOptionsForExistingObject] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PopupFactoryOptionsForExistingObject.htm): PopupFactoryOptionsForExistingObject: object & PopupFactoryOptions
  - Second paragraph: artifactId: number
  - Headings: H1: Type Alias: PopupFactoryOptionsForExistingObject | H2: Type declaration | H3: artifactId

- [Type Alias: PopupFactoryOptionsForNewObject] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PopupFactoryOptionsForNewObject.htm): PopupFactoryOptionsForNewObject: object & PopupFactoryOptions
  - Second paragraph: optionalassociatedArtifactId: number
  - Headings: H1: Type Alias: PopupFactoryOptionsForNewObject | H2: Type declaration | H3: associatedArtifactId? | H3: connectorFieldArtifactId? | H3: parentArtifactId

- [Type Alias: PreReportEventHandler()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PreReportEventHandler__.htm): PreReportEventHandler: (metric) => void
  - Second paragraph: Event handler function for the PreReport event
  - Headings: H1: Type Alias: PreReportEventHandler() | H2: Parameters | H2: Returns

- [Type Alias: QueueItemType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_QueueItemType.htm): QueueItemType: RelativityQueueItemType | string
  - Second paragraph: Queue item type
  - Headings: H1: Type Alias: QueueItemType

- [Type Alias: RangeHighlightSetConfig] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RangeHighlightSetConfig.htm): RangeHighlightSetConfig: PartialHighlightConfig
  - Second paragraph: Copied from oiapi.d.ts
  - Headings: H1: Type Alias: RangeHighlightSetConfig

- [Type Alias: RedactionTextSize] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RedactionTextSize.htm): RedactionTextSize: "auto" | number
  - Second paragraph: Redaction text size option
  - Headings: H1: Type Alias: RedactionTextSize

- [Type Alias: RenderContentHighlightsFn()<VType, CType, CTType, CKType, CVType>] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RenderContentHighlightsFn__VType__CType__CTType__CKType__CVType.htm): RenderContentHighlightsFn<VType, CType, CTType, CKType, CVType>: (params) => Promise<void>
  - Second paragraph: • VTypeextendsIViewerCardInstance = IViewerCardInstance
  - Headings: H1: Type Alias: RenderContentHighlightsFn()<VType, CType, CTType, CKType, CVType> | H2: Type Parameters | H2: Parameters | H2: Returns

- [Type Alias: RTCMessageHandlerFn()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RTCMessageHandlerFn__.htm): RTCMessageHandlerFn: (api, ...rest) => void
  - Second paragraph: Type definition for IRTCMessageHandler handler function
  - Headings: H1: Type Alias: RTCMessageHandlerFn() | H2: Parameters | H2: Returns

- [Type Alias: SelectionRangeMemento] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_SelectionRangeMemento.htm): SelectionRangeMemento: TextRangeMemento | CellRangeMemento | RectRangeMemento
  - Second paragraph: The range memento for a selection on viewer content. This can be a text range memento, a cell range memento, or a rect range memento.
  - Headings: H1: Type Alias: SelectionRangeMemento

- [Type Alias: SupportedCacheKeyTypeUnion] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_SupportedCacheKeyTypeUnion.htm): SupportedCacheKeyTypeUnion: string | number
  - Second paragraph: Supported cache key types
  - Headings: H1: Type Alias: SupportedCacheKeyTypeUnion

- [Type Alias: TextProvider()] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_TextProvider__.htm): TextProvider: () => string | Promise<string>
  - Second paragraph: Function that returns text or a Promise that resolves to the text
  - Headings: H1: Type Alias: TextProvider() | H2: Returns

- [Type Alias: ViewerType] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ViewerType.htm): ViewerType: RelativityViewerType | string
  - Second paragraph: Viewer type
  - Headings: H1: Type Alias: ViewerType

- [Unsupported Items] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Unsupported_Items.htm): The IViewerCardConfig.supportsItem method is used to determine whether a viewer type supports a specific item in the queue. When a viewer type indicates that it doesn't support a queue item, the viewer collection can handle the situation in multiple ways depending on the viewer tab visibility mode. For information about viewer tab visibility mode, see Viewer Tabs.
  - Second paragraph: Additionally, the Relativity Review Interface allows extensions to configure how this situation is handled.
  - Headings: H1: Unsupported Items | H2: Viewer tabs | H2: Viewer card overlays

- [Upgrade considerations for viewer integrations] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Upgrade_considerations_for_viewer_integrations.htm): Relativity Review introduces changes to the technology used by the HTML viewer and the DOM structure used in it. At the same time, many of the existing workflows and programming entities that you may have used for viewer customizations remain the same.
  - Second paragraph: Review the following sections on this page for information about features of the Review Interface that may require upgrading your existing custom integrations.
  - Headings: H1: Upgrade considerations for viewer integrations | H2: Viewer technology and DOM changes | H3: Updated DOM structure | H3: Unavailable PDFTron JavaScript APIs | H2: Viewer integration guidelines

- [UserPreferences] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/UserPreferences.htm)
  - Headings: H1: UserPreferences | H2: Index | H3: Interfaces

- [Using the Review APIs] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Using_the_Review_APIs.htm): You can use the Relativity Review API to determine the build type, version, and other information about viewer. In addition, it provides an API supports CRUD and other methods for markups and markup sets.
  - Second paragraph: Note: The Relativity Review API will continue to undergo minor contract changes and further enhancements. The following functionality will continue to be supported for the full release of the APIs.
  - Headings: H1: Using the Review APIs | H2: Info API | H2: Viewer API | H3: Access the viewer instance | H3: Markups

- [Using TypeScript] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Using_TypeScript.htm): You can implement Relativity extension scripts in TypeScript, which is a typed superset of JavaScript. It compiles to plain JavaScript that runs in the browser. For more information, see TypeScript.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Using TypeScript | H2: Benefits of TypeScript | H2: Consuming the Review API package | H3: Install the Review API package | H3: Import from the Review API package | H2: Version pinning | H2: Updating the reviewapi version

- [Utilities] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Utilities.htm)
  - Headings: H1: Utilities | H2: Index | H3: Enumerations | H3: Interfaces | H3: Type Aliases | H3: Functions

- [Version] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Version.htm)
  - Headings: H1: Version | H2: Index | H3: Interfaces

- [Viewer] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer.htm)
  - Headings: H1: Viewer | H2: Index | H3: Model / Text | H3: Other | H3: View Highlight

- [Viewer Architecture] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Architecture.htm): In the Relativity Review Interface, the key architectural components for the viewer are the viewer type and collection.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Viewer Architecture | H2: Viewer type | H3: Viewer type sub-components | H2: Viewer collection

- [Viewer Context Menus] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Context_Menus.htm): Custom viewer types aren't currently compatible with the context menu framework. As a result, extensions won't be able to register context menu items in custom viewer types.
  - Headings: H1: Viewer Context Menus

- [Viewer Events] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Events.htm): This page covers two categories of events:
  - Second paragraph: A viewer collection (e.g. api.viewer.mainCollection) emits events throughout the document loading lifecycle. These are the most commonly used events in extensions, since most extension behavior is driven by which document is currently loaded.
  - Headings: H1: Viewer Events | H2: Viewer collection events | H3: Where to register collection event handlers | H3: Registering collection event handlers | H3: contentchanged | H3: contentchanging | H3: contentchangeapproved | H3: activeViewerChanged | H3: documentMetaDataChanged | H3: Other collection events | H2: Individual viewer events | H3: Register viewer event handlers | H3: Common events

- [Viewer Tabs] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Tabs.htm): The viewer collection renders tabs for the different viewer types so users can switch between them. By default, it uses the IViewerCardConfig.title property to render the tab text.
  - Second paragraph: This page contains the following information:
  - Headings: H1: Viewer Tabs | H2: Tab visibility | H3: Full mode | H3: Limited mode | H2: Overriding core viewer types

- [Viewers] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewers.htm): The Relativity Review Interface displays documents to users through the viewer components.
  - Second paragraph: The Relativity Review Interface has the following core viewer types for rendering different forms of documents or files:
  - Headings: H1: Viewers | H2: Core viewer types | H2: Custom viewer types

- [Window] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Window.htm)
  - Headings: H1: Window | H2: Index | H3: Enumerations | H3: Interfaces

- [Window Service] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Window_Service.htm): This page contains the following information:
  - Second paragraph: To create a pop-up window, use the IWindowService.create function. Pass this function an argument of type IApplicationWindowConfig. Set the IApplicationWindowConfig.name property on the config object. This string property is required, must be unique, and can't contain any spaces. Except for the name property, all other properties on IApplicationWindowConfig are optional.
  - Headings: H1: Window Service | H2: Create pop-up windows using the Window Service API | H2: Subscribe to window events | H2: Access the main and Relativity windows | H2: Access a pop-up window by name | H2: Close all pop-up windows

- [Zoom] (https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Zoom.htm)
  - Headings: H1: Zoom | H2: Index | H3: Interfaces


### RSMF
- [RSMF Validator .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_RSMF/RSMFValidatorNETAPI.html): RSMF Validator .NET API Reference

- [RSMF Validator .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_RSMF/RSMF_Validator_NET_API_Reference.htm): Browse the RSMF Validator .NET API reference for the Relativity.RSMFU.Validator.SDK namespace.
  - Headings: H1: RSMF Validator .NET API Reference | H2: Relativity.RSMFU.Validator.SDK


### Script properties
- [acl] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/acl.htm): This tag pulls back a list of ACL ID
  - Second paragraph: You have to specify either the artifact guide or the artifact ID of the object type in order for the list to return correctly.
  - Headings: H1: acl | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Example

- [action] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/action.htm): You can use this tag multiple times to pull back more than one data table from SQL.
  - Second paragraph: The body of an action is a SQL script that allows you to pass in inputs. Inputs are referenced in the body of the action by wrapping their ID values in # symbols.
  - Headings: H1: action | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Reference inputs | H3: Example

- [category] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/filters_category.htm): This element allows you to narrow the field type to a sub-set based on a specific attribute.
  - Second paragraph: The following example demonstrates the use of field ID filter codes.
  - Headings: H1: category | H3: Hierarchy | H3: Syntax | H3: Category values | H3: Example

- [category] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/category.htm): Categories are text fields on the Relativity script object that can help you define the script type. You can also create your own categories.
  - Headings: H1: category | H3: Hierarchy | H3: Syntax | H3: Default categories | H3: Example

- [constant] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/constant.htm): Constants are values (either static or user input) that get passed into the SQL action section. Each constant in the input is entered using XML and contains three main parts.
  - Second paragraph: The input is rendered as a dropdown for selecting the time zone offset. The value is a decimal. For example, for Central Standard Time the value is -6.
  - Headings: H1: constant | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Children | H3: Example

- [description] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/description.htm): The value between these tags is used to populate the description column of the script.
  - Headings: H1: description | H3: Hierarchy | H3: Syntax | H3: Example

- [display] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/display.htm): The display element allows you to control how the script output will be rendered when the script is run.
  - Headings: H1: display | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Children | H3: Example

- [field] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/field.htm): This tag allows you to reference Relativity case fields.
  - Second paragraph: The field input allows you to reference the Relativity work space fields. Each field input must be assigned a name and an ID attribute.
  - Headings: H1: field | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Children | H3: Remarks | H3: Example

- [filters] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/filters.htm): In addition to the id and name, each field input has a filters sub-section, and each filter is defined by a code. When a script is run, Relativity presents the input fields as drop-down menus. The types of fields in the drop-down menu are designated by a filter. This allows the user to easily select the correct case field. If a value is not specified, the tag automatically defaults to zero.
  - Headings: H1: filters | H3: Hierarchy | H3: Syntax | H3: Children

- [input] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/input.htm): This tag allows you to define the orientation of your report as well as define various attributes about your report.
  - Headings: H1: input | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Children

- [key] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/key.htm): A key is a mechanism used to lock a script within Relativity. If a script has an associated key tag, then it will be locked. You can preview a locked script, but you can
  - Headings: H1: key | H3: Hierarchy | H3: Syntax | H3: Example | H3: Edit a locked script

- [name] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/name.htm): The value between these tags is used to name (and populate the Name column of) the script.
  - Headings: H1: name | H3: Hierarchy | H3: Syntax | H3: Example

- [object] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/object.htm): This tag, if used, populates the specified display type with the current instances of the specified object type.
  - Second paragraph: You have to specify either the Artifact GUID or the Artifact ID of the view and object type for the field to render successfully.
  - Headings: H1: object | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Example

- [script] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/script.htm): The top XML element in the Relativity script body.
  - Second paragraph: These child elements are the metadata XML tags used to populate the script information, such as name, version, category, etc. Enter any required properties directly into your XML script. If you don't give a value to the property, it displays blank.
  - Headings: H1: script | H3: Hierarchy | H3: Syntax | H3: Child elements | H3: Example

- [Script properties] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/Script_properties.htm): Properties are the metadata XML tag attributes used to populate the script information, including the name, description, category, and version. Enter any of these metadata values directly into your XML script. If you don
  - Second paragraph: The following table lists the available script properties.
  - Headings: H1: Script properties

- [search] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/search.htm): This tag, if used, populates a drop-down list of saved searches in the inputs section. The selected search is then converted into the FROM clause of its respective saved search.
  - Second paragraph: The search input allows you to enter a drop-down list of saved searches. Each search input must be assigned a search ID and name.
  - Headings: H1: search | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Input | H3: Example

- [searchprovider] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/searchprovider.htm): This tag, if used, populates a drop-down list of search providers in the case. The selected value is converted into the selected search provider
  - Second paragraph: The search provider input allows you to enter a drop-down list of search providers in the workspace. Each search provider input must be assigned a search provider ID and name.
  - Headings: H1: searchprovider | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Input | H3: Example

- [security] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/security.htm): This element enables you to reference the current user ACL lists in your scripts.
  - Headings: H1: security | H3: Hierarchy | H3: Syntax | H3: Child elements | H3: Example

- [settings] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/settings.htm): This tag defines certain attributes about your report. Currently you can define the report title.
  - Headings: H1: settings | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Example

- [sql] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/sql.htm): This tag, if used, populates a drop-down menu with the return value of an inline SQL statement.
  - Second paragraph: The inputs are the same ID and name tags consistent with other input types. The contents of the SQL tag should be an SQL statement that returns at least two columns; one has to be named Display and the other has to be named ID.
  - Headings: H1: sql | H3: Hierarchy | H3: Syntax | H3: Attributes | H3: Input | H3: Example

- [type] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/type.htm): This tag defines which Relativity field types appear in the filters drop-down menu.
  - Headings: H1: type | H3: Hierarchy | H3: Syntax | H3: Type values

- [version] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/version.htm): The value between these tags is used to track the internal script version.
  - Headings: H1: version | H3: Hierarchy | H3: Syntax | H3: Example


### Scripts
- [Best practices for Relativity scripts] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Best_practices_for_Relativity_scripts.htm): Relativity scripts are a powerful way to extend Relativity. Because of this, they can cause problems if used incorrectly. This section outlines some of those potential problems and how to avoid them.
  - Second paragraph: We recommend that only Relativity and SQL experts who are familiar with XML be in charge of creating, testing, maintaining, and altering Relativity scripts.
  - Headings: H1: Best practices for Relativity scripts | H2: Verify your security permissions | H2: Avoid errors and performance issues | H2: Upgrade scripts  for database schema changes | H2: Contact Support when necessary

- [Create a new Relativity Script] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Creating_a_new_script.htm): If you are a system admin, you can create and edit scripts in Relativity. Before creating a script, it
  - Second paragraph: You can create a script in either  the Relativity Script Library or a single workspace.
  - Headings: H1: Create a new Relativity Script | H2: Relativity Script Library | H2: Workspace scripts

- [Global script variables] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Global_script_variables.htm): The following global script variables go into the content of the action and are replaced with a preset value.
  - Headings: H1: Global script variables

- [Relativity Scripts] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Developing_Relativity_scripts.htm): You can use custom scripts to extend Relativity functionality and modify data sets in workspaces. For example, you can develop scripts to generate custom reports, auto-populate fields, or reformat data based on predetermined parameters.
  - Second paragraph: To create a Relativity script, you use a defined set of inputs to turn a basic XML document into a SQL script. This allows you to manipulate data in Relativity without needing direct access to the SQL Server. See Script properties.
  - Headings: H1: Relativity Scripts

- [Use scripts in Relativity] (https://platform.relativity.com/RelativityaiR/Content/Scripts/Using_scripts_in_Relativity.htm): In Relativity, scripts are Relativity artifacts. This means they are securable and eligible for auditing, just like fields and views. In the Scripts tab in a workspace, you can select from the following script options.
  - Second paragraph: For more information on running a library script, see Scripts on the Relativity Documentation site.
  - Headings: H1: Use scripts in Relativity


### Search Terms Report
- [Search Terms Report .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report_NET_API_Reference.htm): Browse the Search Terms Report .NET API reference for the Relativity.SearchTermsReport.SDK namespace.
  - Headings: H1: Search Terms Report .NET API Reference .NET API Reference | H2: Relativity.SearchTermsReport.SDK

- [Search Terms Report .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/SearchTermsReportNETAPI.html): Search Terms Report .NET API Reference

- [Search Terms Report Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report.htm): Find the Search Terms Report business domain overview, including the changelog, links to the .NET and REST API content, and the version history with supported Relativity versions.
  - Headings: H1: Search Terms Report | H2: Current Search Terms Report API content | H2: Version History

- [Search Terms Report Services (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report_Services_API.htm): Use the Search Terms Report Services .NET API to generate reports, add terms, retry errors, and view build progress for search terms reports.
  - Second paragraph: The Search Terms Report Services API provides functionality for generating a search terms report, adding terms to an existing search terms report, retrying any errors, and viewing the build progress of a specific search terms report.
  - Headings: H1: Search Terms Report Services (.NET) | H2: Fundamentals for the Search Terms Report Services API | H3: Methods | H3: Classes and enumerations | H2: Create a Search Term Report | H2: Create terms for a search terms report | H2: Update terms for a search terms report | H2: Run all terms in a search terms report | H2: Run pending terms in a search terms report | H2: View the build progress of a search terms report | H2: Retry errors in a search terms report | H2: Cancel a running search terms report job | H2: Retrieve the URL for the Search Terms Result tab | H2: Retrieve the URL for a search terms report | H2: Check whether an index contains a long text field | H2: Retrieve the report type choice IDs

- [Search Terms Report Services (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report_Services_in_REST.htm): Use the Search Terms Report Services REST API to create search terms reports, add or update terms, retry errors, and check build progress. Includes guidelines and sample use cases.
  - Second paragraph: The Search Terms Report Services provides functionality for generating a search terms report, adding terms to an existing search terms report, retrying any errors, and viewing the build progress of a specific search terms report.
  - Headings: H1: Search Terms Report Services (REST) | H2: Guidelines for using the Search Terms Report Services | H3: URLs | H2: Create a Search Term Report | H3: Sample JSON request | H2: Create terms for a search terms report | H3: Request field descriptions | H3: Sample JSON request | H3: Sample JSON response | H2: Update terms for a search terms report | H3: Request field descriptions | H3: Sample JSON request | H2: Run all terms in a search terms report | H2: Run pending terms in a search terms report | H2: View the build progress of a search terms report | H3: Response field descriptions | H3: Sample JSON response | H2: Retry errors in a search terms report | H2: Cancel a running search terms report job | H2: Retrieve the URL for the Search Terms Result tab | H2: Retrieve the URL for a search terms report | H2: Check whether an index contains a long text field | H2: Retrieve object types for Search Terms Report and Result objects | H3: Response field descriptions | H3: Sample JSON response | H2: Retrieve the report type choice IDs | H3: Response field descriptions | H3: Sample JSON response


### Services
- [Relativity Services DataContracts SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Services/ServicesDataContractsNETAPI.html): Relativity Services DataContracts SDK .NET API Reference

- [Relativity Services DataContracts SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Services/Services_Data_Contracts_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.Services.DataContracts.SDK assembly.
  - Headings: H1: Relativity Services DataContracts SDK .NET API Reference | H2: Relativity.Services.DataContracts.SDK

- [Relativity.Services.Interfaces] (https://platform.relativity.com/RelativityaiR/Content/BD_Services/Relativity_Services_Interfaces.htm): Review the Relativity.Services.Interfaces package, which contains interfaces for most legacy Relativity APIs, with links to .NET and REST documentation and the version history.
  - Headings: H1: Relativity.Services.Interfaces | H2: Resources | H2: Version History

- [Relativity.Services.Interfaces .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Services/ServicesInterfacesNETAPI.html): Relativity.Services.Interfaces .NET API Reference

- [Relativity.Services.Interfaces .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Services/Services_Interfaces_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.Services.Interfaces.SDK assembly.
  - Headings: H1: Relativity.Services.Interfaces .NET API Reference | H2: Relativity.Services.Interfaces.SDK


### Site Resources
- [Debugging custom applications and support for custom applications] (https://platform.relativity.com/RelativityaiR/Content/Site_Resources/Custom_Applications_Support.htm): How to debug a custom Relativity application, and what information to provide to Relativity support for help
  - Second paragraph: Unit tests are your best tool for verifying the behavior of your application. Without unit tests, it is not possible to confirm the root cause of a potential defect.   Full unit test coverage of the affected code is required.
  - Headings: H1: Debugging custom applications and support for custom applications | H2: Troubleshooting for all extensibility points | H3: Unit Tests | H3: Logging | H3: Templates | H2: Troubleshooting specific extensibility points | H2: Contacting Relativity

- [Get started with the Relativity DevHelp Community] (https://platform.relativity.com/RelativityaiR/Content/Site_Resources/Get_started_with_DevHelp.htm): Relativity DevHelp Community is a forum for discussing all aspects of Relativity development and posting questions and solutions. We welcome all types of Relativity users, but the forum specifically geared specifically towards those who develop on the Relativity platform.
  - Second paragraph: If you do not have a Relativity Community Portal account, complete the following steps to create an account and join the Relativity Developer Group:
  - Headings: H1: Get started with the Relativity DevHelp Community | H2: Relativity Community user account | H3: Logging into Relativity DevHelp Community | H3: Posting a Topic | H3: Replying to a Topic | H3: Editing a Topic | H2: Community guidelines


### Staging
- [Staging Reports API] (https://platform.relativity.com/RelativityaiR/Content/BD_Staging/Staging_Insights_API.htm): Get an overview of the Staging Reports APIs, which let you enumerate folders and generate and retrieve folder or file reports, with links to the REST guide and the v4 reference.
  - Second paragraph: Staging Reports v3 API and below are deprecated and replaced with v4, which provides better performance and uses new technology to support functionality for future features. See this post in the developer group for more information.
  - Headings: H1: Staging Reports APIs

- [Staging Reports API (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Staging/Staging_Insights_API__REST_.htm): Use the Staging Reports REST API to enumerate staging folders, generate folder or file reports, and retrieve reports. Covers the required permissions and notes that v3 and below are deprecated.
  - Second paragraph: The Staging Reports API (also known as the Staging Insights API) provides a REST service that allows you to generate folder and file reports about tenant data stored in staging areas. This guide will help you get started with the API, including making your first requests, understanding the available endpoints, and authenticating your API calls.
  - Headings: H1: Staging Reports API (REST) | H2: Resources | H2: Permissions | H2: Considerations | H2: URLs | H2: Relativity aiR REST API authentication | H3: Bearer Token Authentication | H2: Rate limiting | H2: Postman sample file | H2: API endpoints/Operations | H3: Get containers | H3: List directories | H3: Generate new report | H3: Generate new summary report | H3: List reports | H3: Get report file | H3: Cancel report | H3: Get billable summary reports | H2: PowerShell code samples for staging reports | H3: Set variables | H3: Obtain access token | H3: Set headers and Uri for staging reports | H3: Retrieve containers | H3: List directories | H3: Generate a new report | H3: List all reports | H3: Get specific report file | H3: Cancel report | H2: Summary

- [Staging Reports REST API (V4) Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Staging/StagingInsightsRESTAPIv4.html): Staging Reports API REST Reference

- [Staging Reports REST API Reference (V4)] (https://platform.relativity.com/RelativityaiR/Content/BD_Staging/Staging_Insights_REST_API_Reference_V4.htm): View the REST API reference for version 4 of the Staging Reports API, the current version that replaces the deprecated v3 and earlier.
  - Headings: H1: Staging Reports REST API Reference (V4)


### Storage
- [Glacier] (https://platform.relativity.com/RelativityaiR/Content/BD_Storage/Glacier.htm): Get an overview of the Glacier Storage API, which creates Glacier data stores, monitors job status, schedules restores, and views reports, with links to REST content and version history.
  - Headings: H1: Glacier Storage API | H2: Current Glacier API content

- [Glacier REST API] (https://platform.relativity.com/RelativityaiR/Content/BD_Storage/Glacier_REST.htm): Use the Glacier Storage REST API to archive data to Glacier, schedule restores, and view reports. Covers authentication, base URLs, and the create Glacier store endpoint.
  - Second paragraph: The Glacier API uses OAuth 2.0 with client credentials flow for authentication.
  - Headings: H1: Glacier Storage API (REST) | H2: Authentication | H2: Base URLs | H3: Creating Glacier Store | H3: Get Glacier Store Job Status | H3: Restoring from Glacier | H3: Get Glacier Restore Status | H3: List Glaciers | H3: Get Inventory Report Details | H2: Usage Examples | H3: Creating a Glacier Store Job | H3: Checking Glacier Store Status | H3: Restoring from Glacier | H3: Checking Restore Status | H3: Listing Glaciers | H3: Getting Glacier Inventory Report Details | H2: Error Handling | H2: Rate Limits | H2: Monitoring and Observability | H2: Best Practices

- [Glacier REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Storage/GlacierRESTAPI.html): Staging Reports API REST Reference

- [Glacier REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Storage/Glacier_REST_API_Reference.htm): View the REST API reference for the Glacier API.
  - Headings: H1: Glacier REST API Reference | H2: Glacier REST API


### Structured Analytics
- [[API NAME] .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/StructuredAnalyticsNETAPI.html): [API NAME] .NET API Reference

- [Structured Analytics .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.StructuredAnalytics.SDK assembly.
  - Headings: H1: Structured Analytics .NET API Reference | H2: Relativity.StructuredAnalytics.SDK

- [Structured Analytics Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics.htm): Find the Structured Analytics business domain overview, including the changelog, links to the .NET and REST Job Manager content, and the version history.
  - Headings: H1: Structured Analytics | H2: Current Structured Analytics API content | H2: Version History

- [Structured Analytics Job Manager (.NET)] (https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Get_started_with_the_Structured_Analytics_API.htm): Use the Structured Analytics Job Manager .NET API to automate structured analytics workflows, such as running an analysis, checking its status, and retrieving document and set errors.
  - Second paragraph: For example, you may want to use the Structured Analytics Job Manager API to implement a custom workflow for running structured analytics sets. With this API, you can automate the process for the analysis and monitoring of these sets. It provides an alternative to manually performing these tasks through the Relativity UI.
  - Headings: H1: Structured Analytics Job Manager (.NET) | H2: Fundamentals for the Structured Analytics Job Manager API | H3: Structured analytics overview | H3: API namespaces | H2: Guidelines for the Structured Analytics Job Manager API | H3: Custom code implementation | H3: Code samples | H3: Relativity environment setup | H2: Generate result fields before running an analysis | H2: Retrieve valid operations for a structured analytics set | H2: Run an analysis of a structured analytics set | H2: Cancel an analysis | H2: Check the status of an analysis | H2: Retry errors in an analysis | H2: Retrieve analysis errors for a structured analytics set | H2: Retrieve document errors for an analysis | H2: Work with legacy document fields | H3: Copy to legacy document fields | H3: Cancel copy to legacy fields

- [Structured Analytics Job Manager (REST)] (https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics_Manager_service_in_REST.htm): Use the Structured Analytics Job Manager REST service to run an analysis of a structured analytics set, check its status, and retrieve errors. Requires the Analytics application.
  - Second paragraph: You can implement custom workflows for programmatically running structured analytic sets using the REST endpoints. For example, you can automate an analysis of a structured analytics set after performing only minor setup tasks in the Relativity UI. You could also implement a custom page that uses these endpoints to display the status of an analysis or errors that may have occurred.
  - Headings: H1: Structured Analytics Job Manager (REST) | H2: Guidelines for the Structured Analytics Job Manager service | H3: URLs | H3: Custom code | H2: Postman sample file | H2: Client code sample | H2: Generate result fields before running an analysis | H2: Retrieve valid operations for a structured analytics set | H2: Run an analysis of a structured analytics set | H2: Cancel an analysis | H2: Check the status of an analysis | H2: Retry errors in an analysis | H2: Retrieve analysis errors for a structured analytics set | H2: Retrieve document errors for an analysis | H2: Work with legacy document fields | H3: Copy results to legacy document fields | H3: Cancel a job for copying content to legacy fields

- [Structured Analytics Jobs Manager REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/StructuredAnalyticsRESTAPI.html): Structured Analytics Jobs REST API Reference

- [Structured Analytics REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics_REST_API_Reference.htm): View the REST API reference for the Structured Analytics Job Manager service.
  - Headings: H1: Structured Analytics REST API Reference | H2: Structured Analytics REST API Reference


### Telemetry
- [Telemetry DataContracts Shared .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryDataContractsSharedNETAPI.html): Telemetry DataContracts Shared .NET API Reference

- [Telemetry DataContracts Shared .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/Telemetry_DataContracts_Shared_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.Telemetry.DataContracts.Shared assembly.
  - Headings: H1: Telemetry DataContracts Shared .NET API Reference | H2: Relativity.Telemetry.DataContracts.Shared

- [Telemetry Metrics REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryMetricsRESTAPI.html): Telemetry Metrics REST API Reference

- [Telemetry Metrics REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryMetrics_REST_API_Reference.htm): View the REST API reference for the Telemetry Metrics service.
  - Headings: H1: Telemetry Metrics REST API Reference | H2: Telemetry Metrics REST API Reference

- [Telemetry Services Interfaces .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryServicesInterfacesNETAPI.html): Telemetry Services Interfaces .NET API Reference

- [Telemetry Services Interfaces .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/Telemetry_Services_Interfaces_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.Telemetry.Services.Interface assembly.
  - Headings: H1: Telemetry Services Interfaces .NET API Reference | H2: Relativity.Telemetry.Services.Interface


### Text Storage
- [Field Size API] (https://platform.relativity.com/RelativityaiR/Content/BD_Text_Storage/Field_Size_API.htm): Use the Text Field Size REST service to return the size in UTF-16 bytes of text in fixed length or long text fields without retrieving the field contents. Covers the URL, headers, and request body.
  - Second paragraph: To use the Text Field Size service, send an POST request to the following base URL:
  - Headings: H1: Field Size API | H2: Service URL | H2: Request headers | H2: Request body | H2: Response | H2: Error handling | H3: HTTP return code | H3: Error message | H3: Error types

- [Text Storage Business Domain Landing Page] (https://platform.relativity.com/RelativityaiR/Content/BD_Text_Storage/Text_Storage.htm): Find the Text Storage business domain overview for storing and retrieving large text payloads, including the changelog and a link to the Field Size API.
  - Second paragraph:  
  - Headings: H1: Text Storage | H2: Text Storage changelog | H2: Current Text Storage API content


### Transfer
- [Transfer Client .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Transfer/TransferClientNETAPI.html): Transfer Client .NET API Reference

- [Transfer Client .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Transfer/Transfer_Client_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.Transfer.Client assembly.
  - Headings: H1: Transfer Client .NET API Reference | H2: Relativity.Transfer.Client


### Transfer API
- [Relativity Transfer SDK] (https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Relativity_Transfer_SDK.htm): Learn about the Relativity Transfer SDK, which uploads and downloads files and directories to and from Relativity aiR fileshares, with its core features, HTTPS-only transfer, and version release notes.
  - Second paragraph: The Relativity Transfer SDK includes the following core features:
  - Headings: H1: Relativity Transfer SDK | H2: Version History | H2: Fundamentals for the Relativity Transfer SDK | H3: Staging Governance compliance | H2: Example of implementing the Relativity Transfer SDK | H2: Code samples | H3: Create instance of SDK client | H3: Transfer progress | H3: Upload a directory | H3: Upload a file | H3: Upload a list of items | H3: Download a file | H3: Download a directory | H2: Job based workflow

- [Relativity Transfer Service] (https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Relativity_Transfer_Service.htm): Use the Transfer Service API to integrate with transfer orchestration systems and move data from Azure DataLake Blob Storage into Relativity. Covers Bearer JWT authentication requirements.
  - Second paragraph: Transfer Service API currently supports Azure DataLake Blob Storage to Relativity transfers only.
  - Headings: H1: Relativity Transfer Service | H2: Authentication | H2: How to start Azure to R1 transfer | H3: Source requirements | H3: Workflow | H3: Job stages | H2: How to get QC report | H3: QC report structure | H2: Error codes | H2: API endpoints | H3: POST v2/transfer/jobs | H3: GET v2/transfer/jobs/ | H3: DELETE v2/transfer/jobs/{job_id} | H3: GET v2/transfer/jobs/{jobId}/qc

- [Relativity Transfer Service NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Transferv2NETAPI.html): Relativity Transfer Service v2

- [Relativity Transfer Service NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Relativity_Transfer_Service_NET_API_Reference.htm): Landing page for the Relativity Transfer Service .NET API reference.
  - Headings: H1: Relativity Transfer Service | H2: Relativity Transfer Service NET API Reference

- [Transfer .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Transfer_API/TransferNETAPI.html): Transfer .NET API Reference

- [Transfer SDK .NET API Reference] (https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Transfer_NET_API_Reference.htm): Browse the .NET API reference for the Relativity.Transfer.SDK namespace.
  - Headings: H1: Transfer SDK .NET API Reference | H2: Relativity.Transfer.SDK


### Troubleshooting
- [Troubleshoot REST API errors] (https://platform.relativity.com/RelativityaiR/Content/REST_API/Troubleshooting/Troubleshooting_the_REST_API.htm): Use the information in the following sections to troubleshoot operations performed through the REST API.
  - Second paragraph: The REST API returns a message in the JSON response when an error occurs during an operation. For example, you execute a GET request which does not support the start parameter as illustrated here:
  - Headings: H1: Troubleshoot REST API errors | H2: HTTP method fails | H3: Incorrect maxRequestLength parameter | H2: Unable to update or delete resources


### Usage Report
- [Usage] (https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/Usage.htm): Get an overview of the Usage Report API, a REST service that centralizes usage reporting across an instance, with links to the getting started guide and the V1 reference.
  - Second paragraph: The Usage Report API provides a REST service that modernizes and centralizes the reporting experience across an instance.
  - Headings: H1: Usage Report API

- [Usage Report REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/UsageReportRESTAPIv1.html): Usage Report API REST Reference

- [Usage Report REST API Reference (V1)] (https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/Usage_Report_API_Reference_V1.htm): View the REST API reference for version 1 of the Usage Report API.
  - Headings: H1: Usage Report REST API Reference (V1)

- [Usage Reports API] (https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/Usage_Reports_API.htm): Get started with the Usage Reports API, including the required instance permissions, URL format with the version path parameter, authentication, and available endpoints.
  - Second paragraph: Review the following guidelines for working with this API.
  - Headings: H1: Usage Reports API | H2: Guidelines for the Usage Reports API | H3: Permissions | H3: URLs | H2: Relativity aiR REST API Authentication | H3: Bearer Token Authentication | H2: Rate Limiting | H2: API Endpoints | H3: Get metadata | H3: List reports | H3: Generate new report | H3: Download report by ID | H3: Get report | H3: Get report details | H3: Delete Report | H2: PowerShell code samples for Usage Reports | H3: Bearer Access tokens in PowerShell | H3: Set headers and Uri for Usage Reports. | H3: Retrieve usage reports | H2: Linked repository metrics migration


### v1
- [Processing Document Manager (.NET) v1] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Document_Manager.htm): Use the IProcessingDocumentManager .NET interface (v1) to retrieve document metadata and error history for documents in a publishing set, with code samples.
  - Second paragraph: <long>: representing the number of publishable documents
  - Headings: H1: Processing Document Manager (.NET) v1 | H2: Retrieve metadata fields and values for a document | H2: Retrieve error history for a document | H2: Retry deleting documents | H2: Retry document errors | H2: Publish documents | H2: Retrieve publish job errors | H2: Retrieve count of publishable documents

- [Processing Document Manager (REST) v1] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Document_Manager_REST.htm): Use the Processing Document Manager REST endpoints (v1) to retrieve document metadata and error history and to retry document deletions and errors.
  - Second paragraph: See the section on Filter expressions for more details on building an Expression value, which may be used in  the Request Body for certain endpoints.
  - Headings: H1: Processing Document Manager (REST) v1 | H2: Retrieve metadata fields and values for a document | H2: Retrieve error history for a document | H2: Retry deleting documents | H2: Retry document errors | H2: Publish documents | H2: Retrieve publish job errors | H2: Retrieve count of publishable documents

- [Processing Filter Manager (.NET) v1] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Filter_Manager_API.htm): Use the Processing Filter Manager .NET API (v1) to create, update, delete, and apply filters that select processed documents before publishing.
  - Second paragraph: As a sample use case, you may want to implement a simplified processing workflow by programmatically adding complex criteria to filters applied to processing jobs in Relativity. This approach eliminates the need to manually enter filter criteria through the UI, which may be time consuming and error prone. Similarly, you can also use the Processing Filter Manager service to modify the settings on these or other complex filters implemented in your environment.
  - Headings: H1: Processing Filter Manager (.NET) v1 | H2: Fundamentals for the Processing Filter Manager API | H3: Methods | H3: Classes and enumerations | H2: Guidelines for the Processing Filter Manager API | H3: Access rights | H3: Helper methods | H3: Filter expressions | H2: Create a processing filter | H2: Apply a processing filter | H2: Update a processing filter | H2: Delete a processing filter | H2: Retrieve discovered documents | H2: Retrieve discovered document IDs | H2: Retrieve the list of discovered files from invariant as a CSV | H2: Retrieve filtered data | H2: Retrieve processing filters | H2: Retrieve processing filters for a data source | H2: Pivot on discovered documents | H2: Download a csv listing of discovered files

- [Processing Filter Manager (REST) v1] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Filter_Manager_service_in_REST.htm): Use the Processing Filter Manager REST service (v1) to create, update, delete, and apply filters that select processed documents before publishing.
  - Second paragraph: As a sample use case, you may want to implement a simplified processing workflow by programmatically adding complex criteria to filters applied to processing jobs in Relativity. This approach eliminates the need to manually enter filter criteria through the UI, which may be time consuming and error prone. Similarly, you can also use the Processing Filter Manager service to modify the settings on these or other complex filters implemented in your environment.
  - Headings: H1: Processing Filter Manager (REST) v1 | H2: Client code sample | H2: Guidelines for the Processing Filter Manager service | H3: Access rights | H3: Helper endpoints | H3: Filter expressions | H2: Create a processing filter | H2: Apply a processing filter | H2: Update a processing filter | H2: Delete a processing filter | H2: Retrieve discovered documents | H2: Retrieve filtered data | H2: Retrieve processing filters | H2: Retrieve processing filters for a data source | H2: Pivot on discovered documents | H2: Get discovered documents IDs | H2: Prepare discovered documents list | H2: Download discovered documents list

- [Processing v1] (https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_v1.htm): Find the entry point to version 1 of the Processing API documentation, with a link to the current Processing content.
  - Headings: H1: Processing v1


### What s new
- [Classic List Page API deprecation] (https://platform.relativity.com/RelativityaiR/Content/What_s_new/Classic_List_Page_API_deprecation.htm): See how deprecated Classic List Page API functionality maps to the newer Relativity Lists API, and plan your migration of customizations such as interaction scripts and event-based APIs.
  - Second paragraph: For migration guidance, see Migrating a Classic List Page Interaction Script to Relativity.Lists.
  - Headings: H1: Classic List Page API deprecation | H2: Initializer API | H2: Event-based APIs | H2: General service APIs

- [Database schema updates] (https://platform.relativity.com/RelativityaiR/Content/What_s_new/Database_schema_updates.htm): Lists changes and additions made to the EDDS and Workspace database schema for Relativity.
  - Second paragraph: Changes marked as Continuous improvement in the Version column below were deployed outside of a planned release.
  - Headings: H1: Database schema updates | H2: Database schema updates table

- [Developer News] (https://platform.relativity.com/RelativityaiR/Content/What_s_new/What_s_new.htm): This page highlights selected new features in Relativity aiR of interest to developers
  - Second paragraph: Due to differences in deployment and update schedules, the items listed below may not yet exist in all environments on the date indicated.
  - Headings: H1: Relativity aiR Developer News | H2: Coming soon | H3: Legacy SQL permissions will be retired | H3: Legacy Relativity.ObjectManager package deprecated | H3: Direct SQL access to the EDDSArchiving database will be removed | H2: Reminders | H3: Platform Architecture Changes | H2: Released Items | H3: Object Manager Rate Limiting | H3: Older versions of Transfer SDK deprecated | H3: Workspace Manager API endpoints deprecated | H3: Processing API endpoints deprecated | H3: v0 version of Processing API deprecated | H3: Legacy Document Viewer APIs deprecated | H3: Cold Storage API endpoints deprecated | H3: The V1 version of ARM API is deprecated | H3: Custom Triggers no longer permitted | H3: Direct access to Processing SQL DataStores removed | H3: New ProcessingFilterManager endpoint for DeNIST reporting | H3: New documentation resources for AI solutions | H3: Staging Reports v3 API deprecated | H3: ProcessingFilterManager and ProcessingDocumentManager V1 APIs deprecation | H3: OAuth2 Client Secrets shown once only | H3: Integration Points load file workflow deprecation | H3: Breaking change affecting List Page Interaction event handlers | H3: Return Processing Duplicate Hash | H3: Error tab deprecation | H3: Data Management: Cold Storage determined by the "Workspace State" field | H3: Collect Folder Path Data Solution deprecation | H3: Lucene Search deprecation | H3: Audit Metrics REST API endpoint deprecation | H3: Breaking change in Relativity Audit API

- [Platform Architecture Changes] (https://platform.relativity.com/RelativityaiR/Content/What_s_new/Platform_Changes.htm): Describes upcoming changes to the Relativity Platform
  - Second paragraph: The table below lists areas  affected by the Platform Architecture changes. You can find scheduling information, impact of the changes, and links to supporting content to help you migrate, or prepare for upcoming changes.
  - Headings: H1: Platform Architecture Changes | H2: Areas affected by the platform changes

- [Relativity aiR release notes] (https://platform.relativity.com/RelativityaiR/Content/What_s_new/Release_notes.htm): View and track product release notes, developer change log, and known issues
  - Second paragraph: If you're experiencing an issue in Relativity aiR and you don't see it listed on the known issues page, contact Client Services.
  - Headings: H1: Relativity aiR release notes | H2: Release notes, developer change log, and known issues.


### Workspace Service
- [Workspace Service API] (https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/Workspace_Service_API.htm): Get started with the Workspace Service API, including the URL format with the version path parameter, authentication methods, response codes, and endpoints such as Get State.
  - Second paragraph: Review the following guidelines for working with this API.
  - Headings: H1: Workspace Service API | H2: Guidelines for the Workspace Service API | H3: URLs | H2: Relativity aiR REST API authentication | H3: Overview | H3: Cookie authentication | H3: Bearer Token Authentication | H2: Response codes | H2: API endpoints | H3: Get State

- [Workspace Service API] (https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/Workspace_Service.htm): Get an overview of the Workspace Service API, a REST service for managing workspace creation and maintenance, with links to the guide and the V1 reference.
  - Second paragraph: The Workspace Service API provides a REST service for managing workspace creation and maintenance.
  - Headings: H1: Workspace Service API

- [Workspace Service REST API Reference] (https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/WorkspaceServiceRESTAPIv1.html): Workspace Service API REST Reference

- [Workspace Service REST API Reference (V1)] (https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/Workspace_Service_API_Reference_V1.htm): View the REST API reference for version 1 of the Workspace Service API.
  - Headings: H1: Workspace Service REST API Reference (V1)