{ "url": "https://platform.relativity.com/RelativityaiR", "description": "An index of all structured documentation pages in the Relativity aiR Developer Documentation for AI agents.", "@type": "Dataset", "version": "1.0", "creator": { "url": "https://www.relativity.com", "name": "Relativity", "@type": "Organization" }, "@context": "https://schema.org", "name": "Relativity aiR Developer Documentation - MCP Index", "distribution": [ { "contentUrl": "https://platform.relativity.com/RelativityaiR/.well-known/mcp-index.json", "encodingFormat": "application/json", "@type": "DataDownload" } ], "hasPart": [ { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Agent_resiliency_guidelines.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Agent_resiliency_guidelines.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Agent Resiliency Guidelines", "Example retry pattern", "Shut down the agent" ], "headings": [ "Agent Resiliency Guidelines", "Example retry pattern", "Shut down the agent" ], "name": "Agent Resiliency Guidelines", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Agent Resiliency Guidelines" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Agent_Status_Manager_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Agent_Status_Manager_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Agent Status Manager, provided in the Relativity.HostingBridge.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Agent Status Manager .NET API Reference", "Relativity.HostingBridge.SDK" ], "headings": [ "Agent Status Manager .NET API Reference", "Relativity.HostingBridge.SDK" ], "name": "Agent Status Manager .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Agent Status Manager, provided in the Relativity.HostingBridge.SDK.", "title": "Agent Status Manager .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Agent_WorkloadDiscovery_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Agent_WorkloadDiscovery_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for Agent Workload Discovery, provided in the Relativity.Platform.Agent.WorkloadDiscovery.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Agent Workload Discovery .NET API Reference", "Relativity.Platform.Agent.WorkloadDiscovery.SDK" ], "headings": [ "Agent Workload Discovery .NET API Reference", "Relativity.Platform.Agent.WorkloadDiscovery.SDK" ], "name": "Agent Workload Discovery .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for Agent Workload Discovery, provided in the Relativity.Platform.Agent.WorkloadDiscovery.SDK.", "title": "Agent Workload Discovery .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/AgentStatusManagerNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/AgentStatusManagerNETAPI.html" }, "description": "Agent Status Manager .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Agent Status Manager .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Agent Status Manager .NET API Reference", "title": "Agent Status Manager .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/AgentWorkloadDiscoveryNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/AgentWorkloadDiscoveryNETAPI.html" }, "description": "Agent Workload Discovery .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Agent Workload Discovery .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Agent Workload Discovery .NET API Reference", "title": "Agent Workload Discovery .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Background_processing.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Background_processing.htm" }, "description": "You can perform background processing in Relativity by developing custom agents. Since these agents perform background work, they don\u0027t interfere with user activities performed through the Relativity UI.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Agents", "Version History" ], "headings": [ "Agents", "Version History" ], "name": "Build agents", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "You can perform background processing in Relativity by developing custom agents. Since these agents perform background work, they don\u0027t interfere with user activities performed through the Relativity UI.", "title": "Build agents" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Basic_concepts_for_agents.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Basic_concepts_for_agents.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Basic concepts for agents", "Common implementation tasks for agents", "Establish a database connection from an agent", "Connect to the Services API with the client-side proxy", "Upload agents to Relativity", "Add an assembly containing an agent", "Remove agents from Relativity", "Remove one agent from an application", "Remove an entire application that contains agents", "Agent runs", "Logging for agent events", "Logging levels" ], "headings": [ "Basic concepts for agents", "Common implementation tasks for agents", "Establish a database connection from an agent", "Connect to the Services API with the client-side proxy", "Upload agents to Relativity", "Add an assembly containing an agent", "Remove agents from Relativity", "Remove one agent from an application", "Remove an entire application that contains agents", "Agent runs", "Logging for agent events", "Logging levels" ], "name": "Basic concepts for agents", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Basic concepts for agents" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Best_practices_for_agents.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Best_practices_for_agents.htm" }, "description": "Use these guidelines to optimize your application development with custom agents.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Best practices for agents", "Optionally use a job queue", "Use helper classes", "Use a Workload discovery endpoint", "Avoid creating App Domains", "Return from the Execute method", "Do not expose HTTP endpoints", "Agents should be ephemeral and fault-tolerant", "Do not rely on Agent IDs", "Establish an appropriate execution pattern", "Use fully qualified domain names when accessing fileshares", "Do not assume fileshare is available before first operation" ], "headings": [ "Best practices for agents", "Optionally use a job queue", "Use helper classes", "Use a Workload discovery endpoint", "Avoid creating App Domains", "Return from the Execute method", "Do not expose HTTP endpoints", "Agents should be ephemeral and fault-tolerant", "Do not rely on Agent IDs", "Establish an appropriate execution pattern", "Use fully qualified domain names when accessing fileshares", "Do not assume fileshare is available before first operation" ], "name": "Best practices for agents", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use these guidelines to optimize your application development with custom agents.", "title": "Best practices for agents" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Building_your_first_agent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Building_your_first_agent.htm" }, "description": "This tutorial illustrates how to create a simple agent that raises the message Hello World! The current time is. \u0026lt;time\u0026gt;. 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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Build your first agent", "Before you begin", "Build an agent" ], "headings": [ "Build your first agent", "Before you begin", "Build an agent" ], "name": "Build your first agent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This tutorial illustrates how to create a simple agent that raises the message Hello World! The current time is. \u0026lt;time\u0026gt;. 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.", "title": "Build your first agent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Execution_patterns_for_agents.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Execution_patterns_for_agents.htm" }, "description": "Learn how to trigger an agent\u0027s Execute() method through scheduled intervals set in application.xml or on demand through the Agent Status Manager API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Execution patterns for agents", "Scheduled intervals", "On-demand", "Agent Status Manager (.NET)", "Agent Status Manager (REST)" ], "headings": [ "Execution patterns for agents", "Scheduled intervals", "On-demand", "Agent Status Manager (.NET)", "Agent Status Manager (REST)" ], "name": "Execution patterns for agents", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn how to trigger an agent\u0027s Execute() method through scheduled intervals set in application.xml or on demand through the Agent Status Manager API.", "title": "Execution patterns for agents" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Scaling_guidelines_for_Agents.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Scaling_guidelines_for_Agents.htm" }, "description": "Use a Workload Discovery endpoint to dynamically scale the number of concurrent agent processes in Relativity aiR, and see which agents benefit from scaling.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Agent Scaling Guidelines", "Scaling fundamentals", "Scaling use cases", "Get started with scaling", "Creating the Workload Discovery endpoint", "Associate the Workload Discovery endpoint with an agent", "Workload discovery best practices" ], "headings": [ "Agent Scaling Guidelines", "Scaling fundamentals", "Scaling use cases", "Get started with scaling", "Creating the Workload Discovery endpoint", "Associate the Workload Discovery endpoint with an agent", "Workload discovery best practices" ], "name": "Agent Scaling Guidelines", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use a Workload Discovery endpoint to dynamically scale the number of concurrent agent processes in Relativity aiR, and see which agents benefit from scaling.", "title": "Agent Scaling Guidelines" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Troubleshooting_agents.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Background_processing/Troubleshooting_agents.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Troubleshoot agents", "headings": "Troubleshoot agents", "name": "Troubleshoot agents", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Troubleshoot agents" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual.htm" }, "description": "Find the .NET and REST API content, version history, and supported version ranges for the Analytics Conceptual business domain.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Analytics Conceptual", "Current Analytics Conceptual API content", "Version History" ], "headings": [ "Analytics Conceptual", "Current Analytics Conceptual API content", "Version History" ], "name": "Analytics Conceptual", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the .NET and REST API content, version history, and supported version ranges for the Analytics Conceptual business domain.", "title": "Analytics Conceptual" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index__.NET_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index__.NET_.htm" }, "description": "Use the .NET Analytics Conceptual Index API to create, manage, and run jobs on conceptual indexes that use Latent Semantic Indexing in Relativity Analytics.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Analytics Conceptual Index (.NET)", "Fundamentals for the Conceptual Index API", "Guidelines for using the Conceptual Index API", "Common workflows", "Catch exceptions", "Execute valid operations for the index state", "Index states and job validation", "Monitor the analysis progress", "Create a conceptual index", "Retrieve a conceptual index", "Update a conceptual index", "Delete a conceptual index", "Helper methods for conceptual index jobs", "Submit a conceptual index job", "Retrieve the status of a job", "Cancel a job" ], "headings": [ "Analytics Conceptual Index (.NET)", "Fundamentals for the Conceptual Index API", "Guidelines for using the Conceptual Index API", "Common workflows", "Catch exceptions", "Execute valid operations for the index state", "Index states and job validation", "Monitor the analysis progress", "Create a conceptual index", "Retrieve a conceptual index", "Update a conceptual index", "Delete a conceptual index", "Helper methods for conceptual index jobs", "Submit a conceptual index job", "Retrieve the status of a job", "Cancel a job" ], "name": "Analytics Conceptual Index (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET Analytics Conceptual Index API to create, manage, and run jobs on conceptual indexes that use Latent Semantic Indexing in Relativity Analytics.", "title": "Analytics Conceptual Index (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index__REST_.htm" }, "description": "Use the REST Analytics Conceptual Index service to create, manage, and run jobs on conceptual indexes that use Latent Semantic Indexing in Relativity Analytics.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Analytics Conceptual Index (REST)", "Guidelines for using the Conceptual Index service", "URLs", "Postman sample file", "Create a conceptual index", "Retrieve a conceptual index", "Update a conceptual index", "Delete a conceptual index", "Helper endpoints for conceptual index jobs", "Submit a conceptual index job", "Retrieve the status of a job", "Cancel a job" ], "headings": [ "Analytics Conceptual Index (REST)", "Guidelines for using the Conceptual Index service", "URLs", "Postman sample file", "Create a conceptual index", "Retrieve a conceptual index", "Update a conceptual index", "Delete a conceptual index", "Helper endpoints for conceptual index jobs", "Submit a conceptual index job", "Retrieve the status of a job", "Cancel a job" ], "name": "Analytics Conceptual Index (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the REST Analytics Conceptual Index service to create, manage, and run jobs on conceptual indexes that use Latent Semantic Indexing in Relativity Analytics.", "title": "Analytics Conceptual Index (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index_NET_API_Reference.htm" }, "description": "Relativity.Analytics.Conceptual.SDK Reference", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Relativity.Analytics.Conceptual.SDK", "headings": [ "Analytics Conceptual Index .NET API Reference", "Relativity.Analytics.Conceptual.SDK" ], "name": "Analytics Conceptual Index .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": [ "Relativity.Analytics.Conceptual.SDK", "Relativity.Analytics.Conceptual.SDK Reference" ], "title": "Analytics Conceptual Index .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/Analytics_Conceptual_Index_REST_API_Reference.htm" }, "description": "conceptual-analytics Reference", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "conceptual-analytics", "headings": [ "Analytics Conceptual Index REST API Reference", "conceptual-analytics" ], "name": "Analytics Conceptual Index REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": [ "conceptual-analytics", "conceptual-analytics Reference" ], "title": "Analytics Conceptual Index REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/AnalyticsConceptualIndexNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/AnalyticsConceptualIndexNETAPI.html" }, "description": "Analytics Conceptual Index .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Analytics Conceptual Index .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Analytics Conceptual Index .NET API Reference", "title": "Analytics Conceptual Index .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/AnalyticsConceptualIndexRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Analytics_Conceptual/AnalyticsConceptualIndexRESTAPI.html" }, "description": "Analytics Conceptual Index REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Analytics Conceptual Index REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Analytics Conceptual Index REST Reference", "title": "Analytics Conceptual Index REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Application/Application_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Application/Application_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Application business domain, provided in the Relativity.Application.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Application SDK .NET API Reference", "Relativity.Application.SDK" ], "headings": [ "Application SDK .NET API Reference", "Relativity.Application.SDK" ], "name": "Application SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Application business domain, provided in the Relativity.Application.SDK.", "title": "Application SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Application/ApplicationNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Application/ApplicationNETAPI.html" }, "description": "Application SDK .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Application SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Application SDK .NET API Reference", "title": "Application SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM.htm" }, "description": "Find the V1 and V3 ARM API content, migration guides, version history, and supported version ranges for the ARM business domain.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ARM", "V3 ARM API content" ], "headings": [ "ARM", "V3 ARM API content" ], "name": "ARM Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the V1 and V3 ARM API content, migration guides, version history, and supported version ranges for the ARM business domain.", "title": "ARM Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_API_V3_migration_guide.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_API_V3_migration_guide.htm" }, "description": "Migrate from the deprecated ARM V1 API to V3, including breaking changes such as string job IDs, new response objects, and the NotifyJobRunner option.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ARM API (REST) V1 to V3 migration guide - part 1", "Breaking changes", "Job ID type change", "Response model changes", "NotificationOptions structure", "MigratorOptions structure", "V1 MigratorOptions boolean flags to V3 ExcludedMigrators mapping", "Restore job DestinationOptions properties removed", "Migrator-specific configuration options", "Feature availability matrix", "Migration paths", "Archive jobs", "Restore jobs", "Job actions", "Features without a migration path", "Part 1 migration checklist", "Additional resources", "Getting help" ], "headings": [ "ARM API (REST) V1 to V3 migration guide - part 1", "Breaking changes", "Job ID type change", "Response model changes", "NotificationOptions structure", "MigratorOptions structure", "V1 MigratorOptions boolean flags to V3 ExcludedMigrators mapping", "Restore job DestinationOptions properties removed", "Migrator-specific configuration options", "Feature availability matrix", "Migration paths", "Archive jobs", "Restore jobs", "Job actions", "Features without a migration path", "Part 1 migration checklist", "Additional resources", "Getting help" ], "name": "ARM API (REST) V1 to V3 migration guide - part 1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Migrate from the deprecated ARM V1 API to V3, including breaking changes such as string job IDs, new response objects, and the NotifyJobRunner option.", "title": "ARM API (REST) V1 to V3 migration guide - part 1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_API_V3_migration_guide_part_2.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_API_V3_migration_guide_part_2.htm" }, "description": "Migrate the ARM job list, status, statistics, available archives, and archive directories endpoints from earlier versions to the V3 REST API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ARM API (REST) V1 to V3 migration guide - part 2", "List Jobs", "Old approach", "New endpoint", "Request body", "Response", "JobState values", "JobType values", "Fields", "Pagination", "What changed", "What you must do", "Job Status", "Old approach", "New endpoint", "Response", "Fields", "Phase and Stage model", "CurrentPhase fields", "What changed versus legacy SQL", "What you must do", "Job Statistics", "Old approach", "New endpoint", "Response", "Migrators entry fields", "What changed versus V1 private", "Error responses", "What you must do", "Available Archives for Restore", "Old approach", "New endpoint", "Request body", "Response shape", "What you must do", "Archive Storage Path Directories", "Old approach", "New endpoint", "Response shape", "What you must do", "Error responses (all endpoints)", "Part 2 migration checklist", "Additional resources", "Getting help" ], "headings": [ "ARM API (REST) V1 to V3 migration guide - part 2", "List Jobs", "Old approach", "New endpoint", "Request body", "Response", "JobState values", "JobType values", "Fields", "Pagination", "What changed", "What you must do", "Job Status", "Old approach", "New endpoint", "Response", "Fields", "Phase and Stage model", "CurrentPhase fields", "What changed versus legacy SQL", "What you must do", "Job Statistics", "Old approach", "New endpoint", "Response", "Migrators entry fields", "What changed versus V1 private", "Error responses", "What you must do", "Available Archives for Restore", "Old approach", "New endpoint", "Request body", "Response shape", "What you must do", "Archive Storage Path Directories", "Old approach", "New endpoint", "Response shape", "What you must do", "Error responses (all endpoints)", "Part 2 migration checklist", "Additional resources", "Getting help" ], "name": "ARM API (REST) V1 to V3 migration guide - part 2", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Migrate the ARM job list, status, statistics, available archives, and archive directories endpoints from earlier versions to the V3 REST API.", "title": "ARM API (REST) V1 to V3 migration guide - part 2" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_NET_API_Reference.htm" }, "description": "Relativity.ARM.SDK Reference", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Relativity.ARM.SDK", "headings": [ "ARM .NET API Reference", "Relativity.ARM.SDK" ], "name": "ARM .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": [ "Relativity.ARM.SDK", "Relativity.ARM.SDK Reference" ], "title": "ARM .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_REST_API_Reference_V3.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARM_REST_API_Reference_V3.htm" }, "description": "Browse the REST API reference for the ARM V3 service, Relativity.ARM.Services.Interfaces V3.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ARM REST API Reference V3", "Relativity.ARM.Services.Interfaces V3" ], "headings": [ "ARM REST API Reference V3", "Relativity.ARM.Services.Interfaces V3" ], "name": "ARM REST API Reference V3", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the REST API reference for the ARM V3 service, Relativity.ARM.Services.Interfaces V3.", "title": "ARM REST API Reference V3" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARMNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARMNETAPI.html" }, "description": "ARM .NET API Reference", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "ARM .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "ARM .NET API Reference", "title": "ARM .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARMRESTAPI_V3.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_ARM/ARMRESTAPI_V3.html" }, "description": "ARM API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "ARM REST API Reference V3", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "ARM API REST Reference", "title": "ARM REST API Reference V3" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit.htm" }, "description": "Find the .NET and REST Audit API content, version history, and supported Relativity and Audit RAP version ranges for the Audit business domain.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Audit", "Current Audit API content", "Version History" ], "headings": [ "Audit", "Current Audit API content", "Version History" ], "name": "Audit Business Domain", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the .NET and REST Audit API content, version history, and supported Relativity and Audit RAP version ranges for the Audit business domain.", "title": "Audit Business Domain" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_APIs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_APIs.htm" }, "description": "Use the .NET Audit APIs to revert, retrieve, and search instance-level and workspace-level audit records stored in Elasticsearch.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Audit (.NET)", "Fundamentals for Audit APIs", "Audit Revert API", "Audit Pivot API", "Reviewer Statistics API", "Audit Query API", "Audit Object Manager UI API", "Guidelines for the Audit APIs", "Operations supported by the Audit APIs", "Admin-level context", "Query conditions", "Audit Revert API", "Validate a revert operation for an audit", "Revert an audit", "Mass revert a list of audits", "Audit Pivot API", "Query with Pivot on audit data", "Reviewer Statistics API", "Retrieve action counts for updated documents", "Retrieve the usage time per reviewer", "Retrieve extracted text size of reviewed documents", "Retrieve an aggregate of user actions by hour", "Retrieve choices reviewed by users", "Retrieve a summary report of reviewer statistics", "Audit Query API", "Query for an audit record", "Audit Object Manager UI API", "Query on audit fields", "Query on audit fields and return a smaller payload" ], "headings": [ "Audit (.NET)", "Fundamentals for Audit APIs", "Audit Revert API", "Audit Pivot API", "Reviewer Statistics API", "Audit Query API", "Audit Object Manager UI API", "Guidelines for the Audit APIs", "Operations supported by the Audit APIs", "Admin-level context", "Query conditions", "Audit Revert API", "Validate a revert operation for an audit", "Revert an audit", "Mass revert a list of audits", "Audit Pivot API", "Query with Pivot on audit data", "Reviewer Statistics API", "Retrieve action counts for updated documents", "Retrieve the usage time per reviewer", "Retrieve extracted text size of reviewed documents", "Retrieve an aggregate of user actions by hour", "Retrieve choices reviewed by users", "Retrieve a summary report of reviewer statistics", "Audit Query API", "Query for an audit record", "Audit Object Manager UI API", "Query on audit fields", "Query on audit fields and return a smaller payload" ], "name": "Audit (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET Audit APIs to revert, retrieve, and search instance-level and workspace-level audit records stored in Elasticsearch.", "title": "Audit (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_NET_API_Reference.htm" }, "description": "Relativity.Audit.SDK Reference", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Relativity.Audit.SDK", "headings": [ "Audit .NET API Reference", "Relativity.Audit.SDK" ], "name": "Audit .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": [ "Relativity.Audit.SDK", "Relativity.Audit.SDK Reference" ], "title": "Audit .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_REST_API_Reference.htm" }, "description": "relativity-audit Reference", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "relativity-audit", "headings": [ "Audit REST API Reference", "relativity-audit" ], "name": "Audit REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": [ "relativity-audit", "relativity-audit Reference" ], "title": "Audit REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_services_in_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/Audit_services_in_REST.htm" }, "description": "Use the REST Audit services to revert, retrieve, and search instance-level and workspace-level audit records stored in Elasticsearch.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Audit (REST)", "Guidelines for Audit services", "URLs", "Operations supported by the Audit services", "Query conditions", "Audit Revert service", "Validate a revert operation for an audit action", "Revert an audit", "Mass revert a list of audits", "Audit Pivot service", "Query with Pivot on audit data", "Reviewer Statistics service", "Retrieve action counts for updated documents", "Retrieve the usage time per reviewer", "Retrieve size of the extracted text for reviewed documents", "Retrieve an aggregation of user actions by hour", "Retrieve choices reviewed by users", "Retrieve a summary report of reviewer statistics", "Audit Query service", "Query for an audit record", "Audit Object Manager UI service", "Query endpoint", "Query on audit fields and return a smaller payload" ], "headings": [ "Audit (REST)", "Guidelines for Audit services", "URLs", "Operations supported by the Audit services", "Query conditions", "Audit Revert service", "Validate a revert operation for an audit action", "Revert an audit", "Mass revert a list of audits", "Audit Pivot service", "Query with Pivot on audit data", "Reviewer Statistics service", "Retrieve action counts for updated documents", "Retrieve the usage time per reviewer", "Retrieve size of the extracted text for reviewed documents", "Retrieve an aggregation of user actions by hour", "Retrieve choices reviewed by users", "Retrieve a summary report of reviewer statistics", "Audit Query service", "Query for an audit record", "Audit Object Manager UI service", "Query endpoint", "Query on audit fields and return a smaller payload" ], "name": "Audit (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the REST Audit services to revert, retrieve, and search instance-level and workspace-level audit records stored in Elasticsearch.", "title": "Audit (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/AuditNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/AuditNETAPI.html" }, "description": "Audit .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Audit .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Audit .NET API Reference", "title": "Audit .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/AuditRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Audit/AuditRESTAPI.html" }, "description": "[API NAME] REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Audit REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "[API NAME] REST Reference", "title": "Audit REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Automated workflows", "Fundamentals of automated workflows", "Troubleshooting information", "Automated Workflows API content", "Version History" ], "headings": [ "Automated workflows", "Fundamentals of automated workflows", "Troubleshooting information", "Automated Workflows API content", "Version History" ], "name": "Automated Workflows", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Automated Workflows" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_API.htm" }, "description": "Use the .NET AutomatedWorkflowsManager to programmatically register actions, register triggers, and send triggers for automated workflows.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Automated Workflows (.NET)", "Working with the Automated Workflows API", "Instantiating the Automated Workflows Manager", "Using the SDK on a Kepler Service", "Using the SDK on an Event Handler", "Registering your Trigger", "Registering your action", "RPC", "Long Running RPC", "Registering your Action", "Action Definition Variables", "Registering your action with a dynamic rule", "Versioning your trigger or action", "Updating workflows to use the latest version of a trigger/action", "Sending a trigger/triggering workflows that use your trigger", "Validating your workflow", "Code samples", "Register a trigger", "Register an action", "Send a trigger", "Deleting a trigger", "Deleting an action" ], "headings": [ "Automated Workflows (.NET)", "Working with the Automated Workflows API", "Instantiating the Automated Workflows Manager", "Using the SDK on a Kepler Service", "Using the SDK on an Event Handler", "Registering your Trigger", "Registering your action", "RPC", "Long Running RPC", "Registering your Action", "Action Definition Variables", "Registering your action with a dynamic rule", "Versioning your trigger or action", "Updating workflows to use the latest version of a trigger/action", "Sending a trigger/triggering workflows that use your trigger", "Validating your workflow", "Code samples", "Register a trigger", "Register an action", "Send a trigger", "Deleting a trigger", "Deleting an action" ], "name": "Automated Workflows (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET AutomatedWorkflowsManager to programmatically register actions, register triggers, and send triggers for automated workflows.", "title": "Automated Workflows (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for Automated Workflows, provided in the Relativity.AutomatedWorkflows.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Automated Workflows .NET API Reference", "Relativity.AutomatedWorkflows.SDK" ], "headings": [ "Automated Workflows .NET API Reference", "Relativity.AutomatedWorkflows.SDK" ], "name": "Automated Workflows .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for Automated Workflows, provided in the Relativity.AutomatedWorkflows.SDK.", "title": "Automated Workflows .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_REST_API_Reference.htm" }, "description": "Browse the REST API reference for the relativity-automated-workflows service.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Automated Workflows REST API Reference", "relativity-automated-workflows" ], "headings": [ "Automated Workflows REST API Reference", "relativity-automated-workflows" ], "name": "Automated Workflows REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the REST API reference for the relativity-automated-workflows service.", "title": "Automated Workflows REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/Automated_Workflows_service.htm" }, "description": "Use the Automated Workflows REST service to register actions, register triggers, and send triggers, including optional CID authorization for HTTP steps.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Automated Workflows (REST)", "URLs", "CID authorization (resource and scopes)", "Methods", "Examples", "Create a client in .NET to interact with the REST Service", "List Triggers", "Create or Update a Trigger", "Delete a Trigger", "List Actions", "Create or Update an Action", "Create or Update an Action with Dynamic Rule", "Delete Action", "Send Trigger/Notify Event", "Validate Workflow" ], "headings": [ "Automated Workflows (REST)", "URLs", "CID authorization (resource and scopes)", "Methods", "Examples", "Create a client in .NET to interact with the REST Service", "List Triggers", "Create or Update a Trigger", "Delete a Trigger", "List Actions", "Create or Update an Action", "Create or Update an Action with Dynamic Rule", "Delete Action", "Send Trigger/Notify Event", "Validate Workflow" ], "name": "Automated Workflows (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Automated Workflows REST service to register actions, register triggers, and send triggers, including optional CID authorization for HTTP steps.", "title": "Automated Workflows (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/AutomatedWorkflowNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/AutomatedWorkflowNETAPI.html" }, "description": "Automated Workflow .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Automated Workflow .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Automated Workflow .NET API Reference", "title": "Automated Workflow .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/AutomatedWorkflowRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Automated_Workflows/AutomatedWorkflowRESTAPI.html" }, "description": "Automated Workflows REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Automated Workflows API REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Automated Workflows REST API Reference", "title": "Automated Workflows API REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing.htm" }, "description": "Find the Billing APIs for retrieving billing information, including the Billing Insights REST API and its API reference.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Billing APIs", "headings": "Billing APIs", "name": "Billing APIs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the Billing APIs for retrieving billing information, including the Billing Insights REST API and its API reference.", "title": "Billing APIs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing_Insights_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing_Insights_API.htm" }, "description": "Use the read-only Billing Insights REST API to retrieve billing metrics by instance, workspace, matter, and client for your Relativity aiR tenant.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Billing Insights API (REST)", "Resources", "Methods", "Authentication", "Bearer Token Authentication", "Errors", "Response Codes", "Pagination", "Remarks", "Sorting", "Hashing", "Client code generation", "Code Samples", "Version History" ], "headings": [ "Billing Insights API (REST)", "Resources", "Methods", "Authentication", "Bearer Token Authentication", "Errors", "Response Codes", "Pagination", "Remarks", "Sorting", "Hashing", "Client code generation", "Code Samples", "Version History" ], "name": "Billing Insights API (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the read-only Billing Insights REST API to retrieve billing metrics by instance, workspace, matter, and client for your Relativity aiR tenant.", "title": "Billing Insights API (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing_Insights_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing_Insights_REST_API_Reference.htm" }, "description": "Browse the REST API reference for version 2 of the Billing Insights API, billing-insights.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Billing Insights REST API Reference (V2)", "billing-insights" ], "headings": [ "Billing Insights REST API Reference (V2)", "billing-insights" ], "name": "Billing Insights REST API Reference (V2)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the REST API reference for version 2 of the Billing Insights API, billing-insights.", "title": "Billing Insights REST API Reference (V2)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing_Insights_REST_API_Reference_V1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/Billing_Insights_REST_API_Reference_V1.htm" }, "description": "Browse the REST API reference for version 1 of the Billing Insights API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Billing Insights REST API Reference (V1)", "headings": "Billing Insights REST API Reference (V1)", "name": "Billing Insights REST API Reference (V1)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the REST API reference for version 1 of the Billing Insights API.", "title": "Billing Insights REST API Reference (V1)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/BillingInsightsRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/BillingInsightsRESTAPI.html" }, "description": "Billing Insights API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Billing Insights REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Billing Insights API REST Reference", "title": "Billing Insights REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/BillingInsightsRESTAPIv1.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Billing/BillingInsightsRESTAPIv1.html" }, "description": "Billing Insights API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Billing Insights REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Billing Insights API REST Reference", "title": "Billing Insights REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Collect/Collect_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Collect/Collect_API.htm" }, "description": "Use the Collect API to create and run collection jobs in Relativity aiR, generate and validate targets, monitor job status, and receive webhook events.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Collect API", "Guidelines for the Collect API", "URLs", "Authentication \u0026amp; Authorization", "Bearer Token Authentication", "Authorization", "Error Model", "Idempotency \u0026amp; Rate Limits", "Idempotency", "Rate limits \u0026amp; concurrency", "Data Models", "CollectionJobModel", "Criteria (normalized)", "CreateCollectionAPIModel (request)", "StartJobResult", "TargetGenerationJobResults", "Webhook subscription", "Webhook event payload", "Endpoint Reference (CollectAPIController v1)", "Create Collection", "Start Target Generation", "Get Target Generation Job Results", "Start Collection", "Get Collection Status", "Stop Collection Job", "Additional (logical) endpoints from the model", "Limits \u0026amp; Constraints (v1)", "State machine", "Monitoring, Audit \u0026amp; Usage", "Security", "Pagination \u0026amp; Filtering", "End-to-End Example (cURL)", "Create a collection", "Start target generation", "Poll target generation results", "Start the collection", "Poll collection status", "Stop the collection (optional)", "Read artifacts/delivery outputs" ], "headings": [ "Collect API", "Guidelines for the Collect API", "URLs", "Authentication \u0026amp; Authorization", "Bearer Token Authentication", "Authorization", "Error Model", "Idempotency \u0026amp; Rate Limits", "Idempotency", "Rate limits \u0026amp; concurrency", "Data Models", "CollectionJobModel", "Criteria (normalized)", "CreateCollectionAPIModel (request)", "StartJobResult", "TargetGenerationJobResults", "Webhook subscription", "Webhook event payload", "Endpoint Reference (CollectAPIController v1)", "Create Collection", "Start Target Generation", "Get Target Generation Job Results", "Start Collection", "Get Collection Status", "Stop Collection Job", "Additional (logical) endpoints from the model", "Limits \u0026amp; Constraints (v1)", "State machine", "Monitoring, Audit \u0026amp; Usage", "Security", "Pagination \u0026amp; Filtering", "End-to-End Example (cURL)", "Create a collection", "Start target generation", "Poll target generation results", "Start the collection", "Poll collection status", "Stop the collection (optional)", "Read artifacts/delivery outputs" ], "name": "Collect API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Collect API to create and run collection jobs in Relativity aiR, generate and validate targets, monitor job status, and receive webhook events.", "title": "Collect API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Collect/Collect_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Collect/Collect_REST_API_Reference.htm" }, "description": "Browse the REST API reference for the Collect API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Collect REST API Reference", "headings": "Collect REST API Reference", "name": "Collect REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the REST API reference for the Collect API.", "title": "Collect REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Collect/CollectRESTAPI1.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Collect/CollectRESTAPI1.html" }, "description": "Collect API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Collect REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Collect API REST Reference", "title": "Collect REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Contracts/Contracts.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Contracts/Contracts.htm" }, "description": "Find the REST services for integrating with the Contracts application, including the Contracts Offsets and hOCR services, with version history.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Contracts", "Current Contracts API content", "Version History" ], "headings": [ "Contracts", "Current Contracts API content", "Version History" ], "name": "Contracts", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the REST services for integrating with the Contracts application, including the Contracts Offsets and hOCR services, with version history.", "title": "Contracts" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Contracts/Contracts_Offsets_Service__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Contracts/Contracts_Offsets_Service__REST_.htm" }, "description": "Use the Contracts Offsets Service REST API to create and manage offsets that link field values to text in contract documents.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Contracts Offsets Service (REST)", "Guidelines for the Contracts Offsets Service", "URLs", "Client Code Example", "Create Offsets", "Request field descriptions", "Sample JSON request", "Response field descriptions", "Sample JSON response", "Read Offsets", "Update Offsets", "Request field descriptions", "Sample JSON Request", "Response field descriptions", "Sample JSON Response", "Delete An Offset", "Upsert Offsets" ], "headings": [ "Contracts Offsets Service (REST)", "Guidelines for the Contracts Offsets Service", "URLs", "Client Code Example", "Create Offsets", "Request field descriptions", "Sample JSON request", "Response field descriptions", "Sample JSON response", "Read Offsets", "Update Offsets", "Request field descriptions", "Sample JSON Request", "Response field descriptions", "Sample JSON Response", "Delete An Offset", "Upsert Offsets" ], "name": "Contracts Offsets Service (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Contracts Offsets Service REST API to create and manage offsets that link field values to text in contract documents.", "title": "Contracts Offsets Service (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Contracts/hOCR_Service__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Contracts/hOCR_Service__REST_.htm" }, "description": "Use the Contracts hOCR Service REST API to read hOCR data created by the Contracts OCR Agent for each page of a document.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "hOCR Service (REST)", "Guidelines for the hOCR Service", "URLs", "Client Code Example", "Read hOCR Data", "Response field descriptions", "Sample JSON response", "Adding or Updating hOCR Data", "Sample JSON body", "Sample JSON response" ], "headings": [ "hOCR Service (REST)", "Guidelines for the hOCR Service", "URLs", "Client Code Example", "Read hOCR Data", "Response field descriptions", "Sample JSON response", "Adding or Updating hOCR Data", "Sample JSON body", "Sample JSON response" ], "name": "hOCR Service (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Contracts hOCR Service REST API to read hOCR data created by the Contracts OCR Agent for each page of a document.", "title": "hOCR Service (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Data_Visualization.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Data_Visualization.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Data Visualization", "Current Data Visualization API content", "Version History" ], "headings": [ "Data Visualization", "Current Data Visualization API content", "Version History" ], "name": "Data Visualization Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Data Visualization Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Data_Visualization_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Data_Visualization_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Data Visualization business domain, provided in the Relativity.DataVisualization.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Data Visualization .NET API Reference", "Relativity.DataVisualization.SDK" ], "headings": [ "Data Visualization .NET API Reference", "Relativity.DataVisualization.SDK" ], "name": "Data Visualization .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Data Visualization business domain, provided in the Relativity.DataVisualization.SDK.", "title": "Data Visualization .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Data_Visualization_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Data_Visualization_REST_API_Reference.htm" }, "description": "Browse the REST API reference for the relativity-data-visualization service.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Data Visualization REST API Reference", "relativity-data-visualization" ], "headings": [ "Data Visualization REST API Reference", "relativity-data-visualization" ], "name": "Data Visualization REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the REST API reference for the relativity-data-visualization service.", "title": "Data Visualization REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/DataVisualizationNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/DataVisualizationNETAPI.html" }, "description": "Data Visualization .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Data Visualization .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Data Visualization .NET API Reference", "title": "Data Visualization .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/DataVisualizationRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/DataVisualizationRESTAPI.html" }, "description": "Data Visualization REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Data Visualization REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Data Visualization REST API Reference", "title": "Data Visualization REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Layout_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Layout_Manager_API.htm" }, "description": "Use the .NET Layout Manager API to create, read, update, and delete layouts, and to retrieve users who can own layouts.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Layout Manager (.NET)", "Fundamentals for the Layout Manager API", "Create a layout", "Read a layout", "Update a layout", "Delete a layout", "Retrieve users for layout ownership" ], "headings": [ "Layout Manager (.NET)", "Fundamentals for the Layout Manager API", "Create a layout", "Read a layout", "Update a layout", "Delete a layout", "Retrieve users for layout ownership" ], "name": "Layout Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET Layout Manager API to create, read, update, and delete layouts, and to retrieve users who can own layouts.", "title": "Layout Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Layout_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Layout_Manager_service.htm" }, "description": "Use the Layout Manager REST service to create, read, update, and delete layouts, and to retrieve users who can own layouts.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Layout Manager (REST)", "Guidelines for the Layout Manager service", "URLs", "Client code sample", "Create a layout", "Read a layout", "Update a layout", "Delete a layout", "Retrieve users for layout ownership" ], "headings": [ "Layout Manager (REST)", "Guidelines for the Layout Manager service", "URLs", "Client code sample", "Create a layout", "Read a layout", "Update a layout", "Delete a layout", "Retrieve users for layout ownership" ], "name": "Layout Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Layout Manager REST service to create, read, update, and delete layouts, and to retrieve users who can own layouts.", "title": "Layout Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Object_Rule_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Object_Rule_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Rule Manager (.NET)", "Fundamentals for managing object rules", "Guidelines for the Object Rule Manager API", "Create an object rule", "Read an object rule", "Update an object rule", "Delete an object rule", "Delete multiple object rules", "Retrieve choices, choice fields, layouts, or associated objects" ], "headings": [ "Object Rule Manager (.NET)", "Fundamentals for managing object rules", "Guidelines for the Object Rule Manager API", "Create an object rule", "Read an object rule", "Update an object rule", "Delete an object rule", "Delete multiple object rules", "Retrieve choices, choice fields, layouts, or associated objects" ], "name": "Object Rule Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Object Rule Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Object_Rule_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Object_Rule_Manager_service.htm" }, "description": "Use the Object Rule Manager REST service to manage object rules that customize object type behavior, and download Postman sample files for the endpoints.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Rule Manager (REST)", "Postman sample files", "Guidelines for the Object Rule Manager service", "Fundamentals for Object Rule Manager service", "Create an object rule", "Read an object rule", "Update an object rule", "Delete an object rule", "Delete multiple object rules", "Retrieve choices, choice fields, layouts, or associated objects" ], "headings": [ "Object Rule Manager (REST)", "Postman sample files", "Guidelines for the Object Rule Manager service", "Fundamentals for Object Rule Manager service", "Create an object rule", "Read an object rule", "Update an object rule", "Delete an object rule", "Delete multiple object rules", "Retrieve choices, choice fields, layouts, or associated objects" ], "name": "Object Rule Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Object Rule Manager REST service to manage object rules that customize object type behavior, and download Postman sample files for the endpoints.", "title": "Object Rule Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Tab_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Tab_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Tab Manager (.NET)", "Fundamentals for managing tabs", "Guidelines for using the Tab Manager service", "Access the Tab Manager service", "Admin-level context", "Retrieve a value from a Task object", "Set ParentID property", "Use of response data from read operations", "IconIdentifier property", "Create a tab", "Retrieve tab metadata", "Update a tab", "Delete a tab", "Retrieve object types for a tab", "Retrieve eligible parent tabs", "Retrieve workspace-level metadata for admin and system tabs", "Retrieve tab orders", "Retrieve all tabs for navigation" ], "headings": [ "Tab Manager (.NET)", "Fundamentals for managing tabs", "Guidelines for using the Tab Manager service", "Access the Tab Manager service", "Admin-level context", "Retrieve a value from a Task object", "Set ParentID property", "Use of response data from read operations", "IconIdentifier property", "Create a tab", "Retrieve tab metadata", "Update a tab", "Delete a tab", "Retrieve object types for a tab", "Retrieve eligible parent tabs", "Retrieve workspace-level metadata for admin and system tabs", "Retrieve tab orders", "Retrieve all tabs for navigation" ], "name": "Tab Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Tab Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Tab_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/Tab_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Tab Manager (REST)", "Guidelines for the Tab Manager service", "URLs", "JSON payloads for create and update operations", "IconIdentifier field", "Client code sample", "Create a tab", "Retrieve tab metadata", "Update a tab", "Delete a tab", "Retrieve object types for a tab", "Retrieve eligible parent tabs", "Retrieve workspace-level metadata for admin and system tabs", "Retrieve tab orders", "Retrieve all tabs for navigation" ], "headings": [ "Tab Manager (REST)", "Guidelines for the Tab Manager service", "URLs", "JSON payloads for create and update operations", "IconIdentifier field", "Client code sample", "Create a tab", "Retrieve tab metadata", "Update a tab", "Delete a tab", "Retrieve object types for a tab", "Retrieve eligible parent tabs", "Retrieve workspace-level metadata for admin and system tabs", "Retrieve tab orders", "Retrieve all tabs for navigation" ], "name": "Tab Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Tab Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/View_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/View_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "View Manager (.NET)", "Fundamentals for the View Manager API", "Create a view in a workspace", "Retrieve information about a view", "Update the properties of a view", "Retrieve the access status of a user", "Retrieve users for view ownership", "Retrieve a list of object types in the workspace" ], "headings": [ "View Manager (.NET)", "Fundamentals for the View Manager API", "Create a view in a workspace", "Retrieve information about a view", "Update the properties of a view", "Retrieve the access status of a user", "Retrieve users for view ownership", "Retrieve a list of object types in the workspace" ], "name": "View Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "View Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/View_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Data_Visualization/View_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "View Manager (REST)", "Guidelines for the View Manager service", "URLs", "Postman sample file", "Client code sample", "Create a view", "Retrieve information about a view", "Update a view", "Retrieve the access status of a user", "Retrieve users for view ownership", "Retrieve a list of object types in a workspace" ], "headings": [ "View Manager (REST)", "Guidelines for the View Manager service", "URLs", "Postman sample file", "Client code sample", "Create a view", "Retrieve information about a view", "Update a view", "Retrieve the access status of a user", "Retrieve users for view ownership", "Retrieve a list of object types in a workspace" ], "name": "View Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "View Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Annotations_Manager__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Annotations_Manager__REST_.htm" }, "description": "Use the Annotations Manager REST service to create, update, retrieve, and delete redactions and highlights on document images in the Image Viewer.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Annotations Manager (REST)", "Guidelines for using the Annotations Manager service", "URLs", "Client code sample", "Create or update annotations", "Retrieve annotations on a document", "Delete annotations from a document" ], "headings": [ "Annotations Manager (REST)", "Guidelines for using the Annotations Manager service", "URLs", "Client code sample", "Create or update annotations", "Retrieve annotations on a document", "Delete annotations from a document" ], "name": "Annotations Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Annotations Manager REST service to create, update, retrieve, and delete redactions and highlights on document images in the Image Viewer.", "title": "Annotations Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer.htm" }, "description": "Find the .NET and REST API content, version history, and supported versions for the Document Viewer business domain, including annotations, highlights, and short messages.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Document Viewer", "Current Document Viewer API content" ], "headings": [ "Document Viewer", "Current Document Viewer API content" ], "name": "Document Viewer", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the .NET and REST API content, version history, and supported versions for the Document Viewer business domain, including annotations, highlights, and short messages.", "title": "Document Viewer" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Document Viewer business domain, provided in the Relativity.DocumentViewer.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Document Viewer .NET API Reference", "Relativity.DocumentViewer.SDK" ], "headings": [ "Document Viewer .NET API Reference", "Relativity.DocumentViewer.SDK" ], "name": "Document Viewer .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Document Viewer business domain, provided in the Relativity.DocumentViewer.SDK.", "title": "Document Viewer .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer_Services_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer_Services_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Document Viewer Services (.NET)", "Fundamentals for the Document Viewer Services API", "Best practices for the conversion requests", "Convert documents", "Convert files contained in File fields on RDOs" ], "headings": [ "Document Viewer Services (.NET)", "Fundamentals for the Document Viewer Services API", "Best practices for the conversion requests", "Convert documents", "Convert files contained in File fields on RDOs" ], "name": "Document Viewer Services (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Document Viewer Services (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer_Services_in_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Document_Viewer_Services_in_REST.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Document Viewer Services (REST)", "Guidelines for using the Document Viewer Services", "URLs", "Client code samples", "Convert documents", "Convert files contained in File fields on RDOs" ], "headings": [ "Document Viewer Services (REST)", "Guidelines for using the Document Viewer Services", "URLs", "Client code samples", "Convert documents", "Convert files contained in File fields on RDOs" ], "name": "Document Viewer Services (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Document Viewer Services (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/DocumentViewerNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/DocumentViewerNETAPI.html" }, "description": "Document Viewer .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Document Viewer .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Document Viewer .NET API Reference", "title": "Document Viewer .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Persistent_Highlight_Service__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Persistent_Highlight_Service__REST_.htm" }, "description": "Use the Persistent Highlight Service REST API to retrieve persistent highlight sets and terms, toggle them active or inactive, and add new terms.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Persistent Highlight Service (REST)", "Guidelines for using the Persistent Highlight Service", "URLs", "Retrieve persistent highlight sets", "Change the state of a persistent highlight set", "Add new terms to a persistent highlight set" ], "headings": [ "Persistent Highlight Service (REST)", "Guidelines for using the Persistent Highlight Service", "URLs", "Retrieve persistent highlight sets", "Change the state of a persistent highlight set", "Add new terms to a persistent highlight set" ], "name": "Persistent Highlight Service (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Persistent Highlight Service REST API to retrieve persistent highlight sets and terms, toggle them active or inactive, and add new terms.", "title": "Persistent Highlight Service (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Review_Service_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Review_Service_REST_API_Reference.htm" }, "description": "Browse the REST API reference for the Review Service, relativity-reviewservice.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Review Service REST API Reference", "relativity-reviewservice" ], "headings": [ "Review Service REST API Reference", "relativity-reviewservice" ], "name": "Review Service REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the REST API reference for the Review Service, relativity-reviewservice.", "title": "Review Service REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/ReviewServiceRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/ReviewServiceRESTAPI.html" }, "description": "Review Service REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Review Service REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Review Service REST Reference", "title": "Review Service REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Short_Message_Viewer_Manager__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Document_Viewer/Short_Message_Viewer_Manager__REST_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Short Message Viewer Manager (REST)", "Guidelines for using the Short Message Viewer Manager service", "URLs", "Retrieve the JSON for a short message", "Retrieve attachment information for a short message", "Retrieve entity information for a participant in a short message document", "Validate the RSMF for a document", "Validate the RSMF for a document", "Use slicing to create a new document with short message events" ], "headings": [ "Short Message Viewer Manager (REST)", "Guidelines for using the Short Message Viewer Manager service", "URLs", "Retrieve the JSON for a short message", "Retrieve attachment information for a short message", "Retrieve entity information for a participant in a short message document", "Validate the RSMF for a document", "Validate the RSMF for a document", "Use slicing to create a new document with short message events" ], "name": "Short Message Viewer Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Short Message Viewer Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch.htm" }, "description": "Find the .NET and REST API content, version history, release notes, and supported version ranges for the dtSearch business domain.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "dtSearch", "Current dtSearch API content", "Version History" ], "headings": [ "dtSearch", "Current dtSearch API content", "Version History" ], "name": "dtSearch Business Domain", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the .NET and REST API content, version history, release notes, and supported version ranges for the dtSearch business domain.", "title": "dtSearch Business Domain" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_API.htm" }, "description": "Use the .NET dtSearch Manager API to programmatically create, build, and manage dtSearch indexes through the IDtSearchIndexManager interface.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "dtSearch Manager (.NET)", "Fundamentals for the dtSearch Manager API", "Methods\u0026#160;", "CRUD operations", "Create a dtSearch index", "Retrieve index metadata", "Update a dtSearch index", "Delete a dtSearch index", "Move a dtSearch index", "Index build operations", "Build Index:\u0026#160;Full", "Build Index:\u0026#160;Incremental", "Build Index", "Cancel a dtSearch index build", "Activate a dtSearch index", "Deactivate a dtSearch index", "Compress a dtSearch index", "Swap a dtSearch index", "Retry errors on a dtSearch index", "Helper methods", "Get active indexes", "Get saved searches\u0026#160;", "Get index share locations\u0026#160;", "Track dtSearch index build progress" ], "headings": [ "dtSearch Manager (.NET)", "Fundamentals for the dtSearch Manager API", "Methods\u0026#160;", "CRUD operations", "Create a dtSearch index", "Retrieve index metadata", "Update a dtSearch index", "Delete a dtSearch index", "Move a dtSearch index", "Index build operations", "Build Index:\u0026#160;Full", "Build Index:\u0026#160;Incremental", "Build Index", "Cancel a dtSearch index build", "Activate a dtSearch index", "Deactivate a dtSearch index", "Compress a dtSearch index", "Swap a dtSearch index", "Retry errors on a dtSearch index", "Helper methods", "Get active indexes", "Get saved searches\u0026#160;", "Get index share locations\u0026#160;", "Track dtSearch index build progress" ], "name": "dtSearch Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET dtSearch Manager API to programmatically create, build, and manage dtSearch indexes through the IDtSearchIndexManager interface.", "title": "dtSearch Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_API_old.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_API_old.htm" }, "description": "Relativity\u0027s dtSearch engine provides advanced search functionality such as proximity, stemming, fuzzy searches, and Boolean operators. For more information, see dtSearch in the Relativity Documentation site. 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 perform the operations on dtSearch DTOs asynchronously.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "dtSearch (.NET)", "dtSearch properties", "Create a dtSearch", "Read a dtSearch", "Update a dtSearch", "Delete a dtSearch", "Query dtSearches", "Helper methods", "Email a link to dtSearch", "Move a dtSearch", "Copy a dtSearch", "Exception handling", "ServiceException", "ValidationException" ], "headings": [ "dtSearch (.NET)", "dtSearch properties", "Create a dtSearch", "Read a dtSearch", "Update a dtSearch", "Delete a dtSearch", "Query dtSearches", "Helper methods", "Email a link to dtSearch", "Move a dtSearch", "Copy a dtSearch", "Exception handling", "ServiceException", "ValidationException" ], "name": "dtSearch (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity\u0027s dtSearch engine provides advanced search functionality such as proximity, stemming, fuzzy searches, and Boolean operators. For more information, see dtSearch in the Relativity Documentation site. 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 perform the operations on dtSearch DTOs asynchronously.", "title": "dtSearch (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_service_in_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_service_in_REST.htm" }, "description": "Use the dtSearch Manager REST service to programmatically create, build, and manage dtSearch indexes in a workspace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "dtSearch Manager (REST)", "URLs", "Operations" ], "headings": [ "dtSearch Manager (REST)", "URLs", "Operations" ], "name": "dtSearch Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the dtSearch Manager REST service to programmatically create, build, and manage dtSearch indexes in a workspace.", "title": "dtSearch Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_service_old.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_Manager_service_old.htm" }, "description": "This topic describes how to interact with the Relativity saved dtSearch using the REST API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "dtSearch (REST)", "Client code sample", "Create", "Read", "Update", "Delete", "Query", "Move", "Copy", "Helper operations", "GetEmailToLinkUrlAsync", "GetFieldsForCriteriaConditionAsync", "GetFieldsForObjectCriteriaCollectionAsync", "GetFieldsForSearchResultViewAsync", "GetSearchIncludesAsync", "GetSearchIndexesAsync", "GetSearchOwnersAsync", "GetAccessStatusAsync" ], "headings": [ "dtSearch (REST)", "Client code sample", "Create", "Read", "Update", "Delete", "Query", "Move", "Copy", "Helper operations", "GetEmailToLinkUrlAsync", "GetFieldsForCriteriaConditionAsync", "GetFieldsForObjectCriteriaCollectionAsync", "GetFieldsForSearchResultViewAsync", "GetSearchIncludesAsync", "GetSearchIndexesAsync", "GetSearchOwnersAsync", "GetAccessStatusAsync" ], "name": "dtSearch (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This topic describes how to interact with the Relativity saved dtSearch using the REST API.", "title": "dtSearch (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the dtSearch Manager, provided in the Relativity.DtSearch.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "dtSearch Manager .NET API Reference", "Relativity.DtSearch.SDK" ], "headings": [ "dtSearch Manager .NET API Reference", "Relativity.DtSearch.SDK" ], "name": "dtSearch Manager .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the dtSearch Manager, provided in the Relativity.DtSearch.SDK.", "title": "dtSearch Manager .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearch_REST_API_Reference.htm" }, "description": "Browse the REST API reference for the dtSearch Manager, relativity-dtsearch.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "dtSearch Manager REST API Reference", "relativity-dtsearch" ], "headings": [ "dtSearch Manager REST API Reference", "relativity-dtsearch" ], "name": "dtSearch Manager REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the REST API reference for the dtSearch Manager, relativity-dtsearch.", "title": "dtSearch Manager REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearchNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearchNETAPI.html" }, "description": "dtSearch .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "dtSearch .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "dtSearch .NET API Reference", "title": "dtSearch .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearchRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_dtSearch/dtSearchRESTAPI.html" }, "description": "dtSearch REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "dtSearch REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "dtSearch REST Reference", "title": "dtSearch REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Application_Install_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Application_Install_API.htm" }, "description": "Use the .NET Application Install API to install applications into workspaces, cancel pending installs, check install status, and resolve conflicts from failed installs.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Application Install (.NET)", "Guidelines for the Application Install API", "Admin-level context", "Actions and pagination", "Permissions", "Sample use cases", "Create a proxy", "Install an application library to specific workspaces", "Install an application library to all workspaces", "Retrieve the installation status of an application", "Retrieve the number of workspaces with an outdated application", "Cancel pending application installations", "Retrieve installation details for an application", "Generate an installation report", "Cancel pending application installations", "Retrieve installation status by workspace", "Supported Condition Fields", "Query for application installations by identifier", "Validate new artifact names", "Query for application installations with additional fields", "Workflow-Based code samples" ], "headings": [ "Application Install (.NET)", "Guidelines for the Application Install API", "Admin-level context", "Actions and pagination", "Permissions", "Sample use cases", "Create a proxy", "Install an application library to specific workspaces", "Install an application library to all workspaces", "Retrieve the installation status of an application", "Retrieve the number of workspaces with an outdated application", "Cancel pending application installations", "Retrieve installation details for an application", "Generate an installation report", "Cancel pending application installations", "Retrieve installation status by workspace", "Supported Condition Fields", "Query for application installations by identifier", "Validate new artifact names", "Query for application installations with additional fields", "Workflow-Based code samples" ], "name": "Application Install (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET Application Install API to install applications into workspaces, cancel pending installs, check install status, and resolve conflicts from failed installs.", "title": "Application Install (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Application_Install_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Application_Install_service.htm" }, "description": "Use the Application Install REST service to install applications into workspaces, cancel pending installs, check install status, and resolve failed install conflicts.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Application Install (REST)", "Client code sample", "Field descriptions for JSON requests", "Install an application library to specific workspaces", "Install an application library to all workspaces", "Retrieve the installation status of an application", "Retrieve the number of workspaces with an outdated application", "Cancel pending application installations", "Retrieve installation details for an application", "Generate an installation report", "Cancel pending application installations", "Retrieve installation status by workspace", "Query for application installations by identifier", "Validate new artifact names", "Query for application installations with additional fields" ], "headings": [ "Application Install (REST)", "Client code sample", "Field descriptions for JSON requests", "Install an application library to specific workspaces", "Install an application library to all workspaces", "Retrieve the installation status of an application", "Retrieve the number of workspaces with an outdated application", "Cancel pending application installations", "Retrieve installation details for an application", "Generate an installation report", "Cancel pending application installations", "Retrieve installation status by workspace", "Query for application installations by identifier", "Validate new artifact names", "Query for application installations with additional fields" ], "name": "Application Install (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Application Install REST service to install applications into workspaces, cancel pending installs, check install status, and resolve failed install conflicts.", "title": "Application Install (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Environment.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Environment.htm" }, "description": "Find the .NET and REST API content, version history, and changelog for the Environment business domain, which configures the Relativity installation or tenant.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Environment", "Current Environment API content", "Version History" ], "headings": [ "Environment", "Current Environment API content", "Version History" ], "name": "Environment Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the .NET and REST API content, version history, and changelog for the Environment business domain, which configures the Relativity installation or tenant.", "title": "Environment Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Environment_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Environment_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Environment business domain, provided in the Relativity.Environment.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Environment .NET API Reference", "Relativity.Environment.SDK" ], "headings": [ "Environment .NET API Reference", "Relativity.Environment.SDK" ], "name": "Environment .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Environment business domain, provided in the Relativity.Environment.SDK.", "title": "Environment .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Environment_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Environment_REST_API_Reference.htm" }, "description": "Browse the REST API reference for the Environment business domain, relativity-environment.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Environment REST API Reference", "relativity-environment" ], "headings": [ "Environment REST API Reference", "relativity-environment" ], "name": "Environment REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the REST API reference for the Environment business domain, relativity-environment.", "title": "Environment REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/EnvironmentNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/EnvironmentNETAPI.html" }, "description": "Environment .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Environment .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Environment .NET API Reference", "title": "Environment .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/EnvironmentRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/EnvironmentRESTAPI.html" }, "description": "Environment REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Environment REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Environment REST API Reference", "title": "Environment REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Error_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Error_Manager_API.htm" }, "description": "Error Manager exposes single endpoint for creating errors, which can be displayed in Error tab in Relativity.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Error Manager (.NET)", "Guidelines for Error Manager API", "Fundamentals for using Error Manager", "Key concepts or other explanatory information", "Guidelines or best practices", "Create an error log", "Create an error log using service manager (recommended)", "Create an error log using an HTTP client" ], "headings": [ "Error Manager (.NET)", "Guidelines for Error Manager API", "Fundamentals for using Error Manager", "Key concepts or other explanatory information", "Guidelines or best practices", "Create an error log", "Create an error log using service manager (recommended)", "Create an error log using an HTTP client" ], "name": "Error Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Error Manager exposes single endpoint for creating errors, which can be displayed in Error tab in Relativity.", "title": "Error Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Error_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Error_Manager_service.htm" }, "description": "Through the REST API, Error Manager exposes single endpoint for creating errors, which can be displayed in Error tab in Relativity.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Error Manager (REST)", "Guidelines for the Error Manager service", "Postman sample file", "Create an error log" ], "headings": [ "Error Manager (REST)", "Guidelines for the Error Manager service", "Postman sample file", "Create an error log" ], "name": "Error Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Through the REST API, Error Manager exposes single endpoint for creating errors, which can be displayed in Error tab in Relativity.", "title": "Error Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Export_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Export_API.htm" }, "description": "Use the .NET Export API to export an application from a workspace as a RAP file or schema file, with ExportAsync code samples.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Export (.NET)", "Guidelines for the Export API", "Permissions", "ExportAsync", "ExportSchemaAsync" ], "headings": [ "Export (.NET)", "Guidelines for the Export API", "Permissions", "ExportAsync", "ExportSchemaAsync" ], "name": "Export (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET Export API to export an application from a workspace as a RAP file or schema file, with ExportAsync code samples.", "title": "Export (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Export_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Export_service.htm" }, "description": "Use the Export REST service to export an application from a workspace as a RAP file or schema file, with a client code sample.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Export (REST)", "Client code sample", "ExportAsync", "ExportSchemaAsync" ], "headings": [ "Export (REST)", "Client code sample", "ExportAsync", "ExportSchemaAsync" ], "name": "Export (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Export REST service to export an application from a workspace as a RAP file or schema file, with a client code sample.", "title": "Export (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Instance_Setting_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Instance_Setting_Manager_API.htm" }, "description": "Use the .NET Instance Setting Manager API to create, read, update, and delete instance settings in a Relativity environment.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Instance Setting Manager (.NET)", "Fundamentals for the Instance Settings Manager API", "Create an instance setting", "Read an instance setting", "Update an instance setting", "Delete an instance setting", "Helper method in code samples" ], "headings": [ "Instance Setting Manager (.NET)", "Fundamentals for the Instance Settings Manager API", "Create an instance setting", "Read an instance setting", "Update an instance setting", "Delete an instance setting", "Helper method in code samples" ], "name": "Instance Setting Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET Instance Setting Manager API to create, read, update, and delete instance settings in a Relativity environment.", "title": "Instance Setting Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Instance_Setting_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Instance_Setting_Manager_service.htm" }, "description": "Use the Instance Setting Manager REST service to create, read, update, and delete instance settings in a Relativity environment.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Instance Setting Manager (REST)", "Guidelines for the Instance Setting Manager service", "URLs", "Postman sample file", "Client code sample", "Create an instance setting", "Read an instance setting", "Update an instance setting", "Delete an instance setting" ], "headings": [ "Instance Setting Manager (REST)", "Guidelines for the Instance Setting Manager service", "URLs", "Postman sample file", "Client code sample", "Create an instance setting", "Read an instance setting", "Update an instance setting", "Delete an instance setting" ], "name": "Instance Setting Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Instance Setting Manager REST service to create, read, update, and delete instance settings in a Relativity environment.", "title": "Instance Setting Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Library_Application_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Library_Application_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Library Application (.NET)", "Guidelines for the Library Application API", "Admin-level context", "Permissions", "Sample use cases", "Endpoints", "CreateAsync", "ReadAsync", "ReadAllAsync", "ReadApplicationContentsAsync", "UpdateAsync", "DeleteAsync", "GetLibraryInstallStatusAsync", "RetryLibraryInstallAsync", "CancelLibraryInstallAsync", "UploadPackageAsync", "DownloadPackageAsync", "DeletePackageAsync", "GetApplicationHostingStatusAsync", "Workflow-Based code samples" ], "headings": [ "Library Application (.NET)", "Guidelines for the Library Application API", "Admin-level context", "Permissions", "Sample use cases", "Endpoints", "CreateAsync", "ReadAsync", "ReadAllAsync", "ReadApplicationContentsAsync", "UpdateAsync", "DeleteAsync", "GetLibraryInstallStatusAsync", "RetryLibraryInstallAsync", "CancelLibraryInstallAsync", "UploadPackageAsync", "DownloadPackageAsync", "DeletePackageAsync", "GetApplicationHostingStatusAsync", "Workflow-Based code samples" ], "name": "Library Application (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Library Application (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Library_Application_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Library_Application_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Library Application (REST)", "Guidelines for the Library Application service", "URLs", "Client code sample", "Create a library application", "Read a library application", "Read all library applications", "Retrieve a library application as a RAP file", "Update a library application", "Delete a library application", "Retrieve the installation status of an application", "Retry installing an application", "Cancel an application installation", "Upload a RAP or XML file", "Download a RAP or XML file", "Delete a RAP file", "Retrieve hosting status of an application" ], "headings": [ "Library Application (REST)", "Guidelines for the Library Application service", "URLs", "Client code sample", "Create a library application", "Read a library application", "Read all library applications", "Retrieve a library application as a RAP file", "Update a library application", "Delete a library application", "Retrieve the installation status of an application", "Retry installing an application", "Cancel an application installation", "Upload a RAP or XML file", "Download a RAP or XML file", "Delete a RAP file", "Retrieve hosting status of an application" ], "name": "Library Application (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Library Application (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Matter_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Matter_Manager_API.htm" }, "description": "Use the .NET Matter Manager API to create, read, update, and delete matters, and to retrieve eligible clients and statuses.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Matter Manager (.NET)", "Retrieve a list of available clients", "Retrieve a list of matter statuses", "Create a matter", "Retrieve metadata for a matter", "Update a matter", "Delete a matter" ], "headings": [ "Matter Manager (.NET)", "Retrieve a list of available clients", "Retrieve a list of matter statuses", "Create a matter", "Retrieve metadata for a matter", "Update a matter", "Delete a matter" ], "name": "Matter Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET Matter Manager API to create, read, update, and delete matters, and to retrieve eligible clients and statuses.", "title": "Matter Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Matter_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Matter_Manager_service.htm" }, "description": "This topic describes how to interact with the Relativity Matter object using the REST API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Matter Manager (REST)", "Guidelines for the Matter Manager service", "URLs", "Postman sample file", "Retrieve a list of available clients", "Retrieve a list of matter statuses", "Create a matter", "Retrieve metadata for a matter", "Update a matter", "Delete a matter" ], "headings": [ "Matter Manager (REST)", "Guidelines for the Matter Manager service", "URLs", "Postman sample file", "Retrieve a list of available clients", "Retrieve a list of matter statuses", "Create a matter", "Retrieve metadata for a matter", "Update a matter", "Delete a matter" ], "name": "Matter Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This topic describes how to interact with the Relativity Matter object using the REST API.", "title": "Matter Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Resource_File_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Resource_File_API.htm" }, "description": "Use the .NET Resource File API to create, read, update, delete, and download resource files for applications, and to list eligible applications.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Resource File (.NET)", "Guidelines for the Resource File API", "Admin-level context", "Sample use cases", "Endpoints", "CreateAsync", "Permissions", "ReadAsync", "Permissions", "UpdateAsync", "Permissions", "DeleteAsync", "Permissions", "DownloadContentsAsync", "Permissions", "UploadContentsAsync", "Permissions", "UpsertAsync", "Permissions", "GetEligibleApplicationsAsync", "Permissions", "PushResourceFiles" ], "headings": [ "Resource File (.NET)", "Guidelines for the Resource File API", "Admin-level context", "Sample use cases", "Endpoints", "CreateAsync", "Permissions", "ReadAsync", "Permissions", "UpdateAsync", "Permissions", "DeleteAsync", "Permissions", "DownloadContentsAsync", "Permissions", "UploadContentsAsync", "Permissions", "UpsertAsync", "Permissions", "GetEligibleApplicationsAsync", "Permissions", "PushResourceFiles" ], "name": "Resource File (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET Resource File API to create, read, update, delete, and download resource files for applications, and to list eligible applications.", "title": "Resource File (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Resource_File_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Resource_File_service.htm" }, "description": "Use the Resource File REST service to create, read, update, delete, and download resource files for applications, and to list eligible applications.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Resource File (REST)", "Guidelines for the Resource File service", "URLs", "Client code sample", "Create a resource file", "Read a resouce file", "Update a resource file", "Delete a resource file", "Download the contents of a resource file", "Upload the contents of a resource file", "Create or update a resource file", "Retrieve available applications" ], "headings": [ "Resource File (REST)", "Guidelines for the Resource File service", "URLs", "Client code sample", "Create a resource file", "Read a resouce file", "Update a resource file", "Delete a resource file", "Download the contents of a resource file", "Upload the contents of a resource file", "Create or update a resource file", "Retrieve available applications" ], "name": "Resource File (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Resource File REST service to create, read, update, delete, and download resource files for applications, and to list eligible applications.", "title": "Resource File (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Workspace_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Workspace_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Workspace Manager (.NET)", "Fundamentals for the Workspace Manager API", "Methods", "Classes", "Guidelines for the Workspace Manager API", "NuGet package", "Create a proxy", "Field permissions", "Cancellation and progress", "Create operation helper methods", "Retrieve unsupported fields for a create operation", "Retrieve a workspace", "Update a workspace", "Retrieve workspace statistics", "Resource information helper methods", "Advanced settings helper methods", "Retrieve available statuses for a workspace", "Retrieve full text languages for SQL Server" ], "headings": [ "Workspace Manager (.NET)", "Fundamentals for the Workspace Manager API", "Methods", "Classes", "Guidelines for the Workspace Manager API", "NuGet package", "Create a proxy", "Field permissions", "Cancellation and progress", "Create operation helper methods", "Retrieve unsupported fields for a create operation", "Retrieve a workspace", "Update a workspace", "Retrieve workspace statistics", "Resource information helper methods", "Advanced settings helper methods", "Retrieve available statuses for a workspace", "Retrieve full text languages for SQL Server" ], "name": "Workspace Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Workspace Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Workspace_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Environment/Workspace_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Workspace Manager (REST)", "Guidelines for the Workspace Manager service", "URLs", "Client code sample", "Create operation helper methods", "Retrieve unsupported fields for a create operation", "Retrieve a workspace", "Update a workspace", "Retrieve workspace statistics", "Advanced settings helper methods", "Retrieve available statuses for a workspace", "Retrieve full text languages for SQL Server", "Retrieve saved searches for production restrictions" ], "headings": [ "Workspace Manager (REST)", "Guidelines for the Workspace Manager service", "URLs", "Client code sample", "Create operation helper methods", "Retrieve unsupported fields for a create operation", "Retrieve a workspace", "Update a workspace", "Retrieve workspace statistics", "Advanced settings helper methods", "Retrieve available statuses for a workspace", "Retrieve full text languages for SQL Server", "Retrieve saved searches for production restrictions" ], "name": "Workspace Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Workspace Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Export/Export_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Export/Export_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Export business domain, provided in the Relativity.Export.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Export .NET API Reference", "Relativity.Export.SDK" ], "headings": [ "Export .NET API Reference", "Relativity.Export.SDK" ], "name": "Export SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Export business domain, provided in the Relativity.Export.SDK.", "title": "Export SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Export/ExportNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Export/ExportNETAPI.html" }, "description": "Export SDK .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Export SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Export SDK .NET API Reference", "title": "Export SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Event_Handler_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Event_Handler_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Event Handler Manager (.NET)", "Fundamentals for managing object event handlers", "Attach an event handler to an object type", "Detach an event handler to an object type", "Retrieve event handlers attached to an object type", "Retrieve available event handlers for an object type" ], "headings": [ "Event Handler Manager (.NET)", "Fundamentals for managing object event handlers", "Attach an event handler to an object type", "Detach an event handler to an object type", "Retrieve event handlers attached to an object type", "Retrieve available event handlers for an object type" ], "name": "Event Handler Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Event Handler Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Event_Handler_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Event_Handler_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Event Handler Manager (REST)", "Postman sample files", "Client code sample", "Attach an event handler to an object type", "Detach an event handler from an object type", "Retrieve event handlers attached to an object type", "Retrieve available event handlers for an object type" ], "headings": [ "Event Handler Manager (REST)", "Postman sample files", "Client code sample", "Attach an event handler to an object type", "Detach an event handler from an object type", "Retrieve event handlers attached to an object type", "Retrieve available event handlers for an object type" ], "name": "Event Handler Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Event Handler Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Extensibility.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Extensibility.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Extensibility", "Current Extensibility API content", "Version History" ], "headings": [ "Extensibility", "Current Extensibility API content", "Version History" ], "name": "Extensibility Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Extensibility Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Extensibility_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Extensibility_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Extensibility business domain, provided in the Relativity.Extensibility.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Extensibility .NET API Reference", "Relativity.Extensibility.SDK" ], "headings": [ "Extensibility .NET API Reference", "Relativity.Extensibility.SDK" ], "name": "Extensibility .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Extensibility business domain, provided in the Relativity.Extensibility.SDK.", "title": "Extensibility .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/ExtensibilityNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/ExtensibilityNETAPI.html" }, "description": "Extensibility .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Extensibility .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Extensibility .NET API Reference", "title": "Extensibility .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Mass_Operation_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Mass_Operation_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Mass Operation Manager (.NET)", "Fundamentals for managing mass operations", "Methods", "Classes", "Guidelines for managing mass operations", "Create a mass operation", "Read a mass operation", "Update a mass operation", "Delete a mass operation", "Retrieve available object types for a mass operation", "Retrieve available event handlers for a mass operation", "Retrieve available layouts for a mass operation" ], "headings": [ "Mass Operation Manager (.NET)", "Fundamentals for managing mass operations", "Methods", "Classes", "Guidelines for managing mass operations", "Create a mass operation", "Read a mass operation", "Update a mass operation", "Delete a mass operation", "Retrieve available object types for a mass operation", "Retrieve available event handlers for a mass operation", "Retrieve available layouts for a mass operation" ], "name": "Mass Operation Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Mass Operation Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Mass_Operation_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Mass_Operation_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Mass Operation Manager (REST)", "Postman sample files", "Client code sample", "Fundamentals for Mass Operation Manager", "Create a mass operation", "Read a mass operation", "Update a mass operation", "Delete a mass operation", "Retrieve available object types for a mass operation", "Retrieve available event handlers for a mass operation", "Retrieve available layouts for a mass operation" ], "headings": [ "Mass Operation Manager (REST)", "Postman sample files", "Client code sample", "Fundamentals for Mass Operation Manager", "Create a mass operation", "Read a mass operation", "Update a mass operation", "Delete a mass operation", "Retrieve available object types for a mass operation", "Retrieve available event handlers for a mass operation", "Retrieve available layouts for a mass operation" ], "name": "Mass Operation Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Mass Operation Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Script_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Script_Manager_API.htm" }, "description": "Use the .NET Script Manager API to create and manage SQL scripts, retrieve and preview input parameters, import scripts, and run script jobs.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Script Manager (.NET)", "Script Manager API fundamentals", "Key concepts", "Troubleshooting information", "Add a script", "Retrieve script metadata", "Modify a script", "Delete a script", "Import a script", "Retrieve script input parameters", "Preview a script", "Queue a script to run", "Retrieve status of a script run job", "Query action results", "Export action results", "Export script report", "Clean up script results" ], "headings": [ "Script Manager (.NET)", "Script Manager API fundamentals", "Key concepts", "Troubleshooting information", "Add a script", "Retrieve script metadata", "Modify a script", "Delete a script", "Import a script", "Retrieve script input parameters", "Preview a script", "Queue a script to run", "Retrieve status of a script run job", "Query action results", "Export action results", "Export script report", "Clean up script results" ], "name": "Script Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET Script Manager API to create and manage SQL scripts, retrieve and preview input parameters, import scripts, and run script jobs.", "title": "Script Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Script_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Script_Manager_service.htm" }, "description": "Use the Script Manager REST service to create and manage SQL scripts, retrieve and preview input parameters, import scripts, and run script jobs.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Script Manager (REST)", "Postman sample file", "Guidelines for the Script Manager service", "URLs", "Client code sample", "Create a script", "Read a script", "Update a script", "Delete a script", "Import a script", "Get script parameters", "Preview a script body and input values", "Run script jobs and reports", "Enqueue run job", "Read run job", "Query action job results", "Export action results", "Export script report", "Clean up run job" ], "headings": [ "Script Manager (REST)", "Postman sample file", "Guidelines for the Script Manager service", "URLs", "Client code sample", "Create a script", "Read a script", "Update a script", "Delete a script", "Import a script", "Get script parameters", "Preview a script body and input values", "Run script jobs and reports", "Enqueue run job", "Read run job", "Query action job results", "Export action results", "Export script report", "Clean up run job" ], "name": "Script Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Script Manager REST service to create and manage SQL scripts, retrieve and preview input parameters, import scripts, and run script jobs.", "title": "Script Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_API.htm" }, "description": "Use the .NET Search Provider API to create, read, update, and delete search providers in a workspace through the ISearchProviderManager interface.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Search Provider (.NET)", "Fundamentals for managing search providers", "Methods", "Create a search provider", "Update a search provider", "Retrieve search provider metadata", "Delete a search provider", "Retrieve a list of dependencies" ], "headings": [ "Search Provider (.NET)", "Fundamentals for managing search providers", "Methods", "Create a search provider", "Update a search provider", "Retrieve search provider metadata", "Delete a search provider", "Retrieve a list of dependencies" ], "name": "Search Provider (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the .NET Search Provider API to create, read, update, and delete search providers in a workspace through the ISearchProviderManager interface.", "title": "Search Provider (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Legacy Search Provider Manager (.NET)", "Search provider fundamentals", "Retrieve search providers" ], "headings": [ "Legacy Search Provider Manager (.NET)", "Search provider fundamentals", "Retrieve search providers" ], "name": "Legacy Search Provider Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Legacy Search Provider Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Legacy Search Provider Manager (REST)", "Client code sample", "Read a SearchProvider" ], "headings": [ "Legacy Search Provider Manager (REST)", "Client code sample", "Read a SearchProvider" ], "name": "Legacy Search Provider Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Legacy Search Provider Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_service_in_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Extensibility/Search_Provider_service_in_REST.htm" }, "description": "Use the Search Provider REST service to create and manage search providers in a workspace, such as keyword, dtSearch, and Analytics providers.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Search Provider (REST)", "Create a search provider", "Update a search provider", "Retrieve search provider metadata", "Delete a search provider", "Retrieve a list of dependencies" ], "headings": [ "Search Provider (REST)", "Create a search provider", "Update a search provider", "Retrieve search provider metadata", "Delete a search provider", "Retrieve a list of dependencies" ], "name": "Search Provider (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Search Provider REST service to create and manage search providers in a workspace, such as keyword, dtSearch, and Analytics providers.", "title": "Search Provider (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Authentication_Provider_Type__.NET_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Authentication_Provider_Type__.NET_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Authentication provider type (.NET)", "Fundamentals for the Authentication Provider Type API", "Methods", "Classes", "Guidelines for the Authentication Provider Type API", "Code sample" ], "headings": [ "Authentication provider type (.NET)", "Fundamentals for the Authentication Provider Type API", "Methods", "Classes", "Guidelines for the Authentication Provider Type API", "Code sample" ], "name": "Authentication provider type (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Authentication provider type (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Authentication_Provider_Type__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Authentication_Provider_Type__REST_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Authentication provider type (REST)", "Guidelines for the Authentication Provider Type service", "URLS", "Retrieve an authentication provider type", "Read all authentication provider types", "Update an authentication provider type" ], "headings": [ "Authentication provider type (REST)", "Guidelines for the Authentication Provider Type service", "URLS", "Retrieve an authentication provider type", "Read all authentication provider types", "Update an authentication provider type" ], "name": "Authentication provider type (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Authentication provider type (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Client_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Client_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Client Manager (.NET)", "Fundamentals for the Client Manager API", "Methods", "Classes", "Guidelines for the Client Manager API", "Create a client proxy", "Retrieve values from Task objects", "Use response data from read operations", "Create a client", "Retrieve a client", "Update a client", "Delete a client", "Helper methods for CRUD operations", "Retrieve associated groups", "Retrieve associated matters", "Retrieve associated users", "Retrieve available statuses", "Methods for client domain activation keys", "Create client domain activation key", "Submit a client domain activation key", "Retry activating a client domain" ], "headings": [ "Client Manager (.NET)", "Fundamentals for the Client Manager API", "Methods", "Classes", "Guidelines for the Client Manager API", "Create a client proxy", "Retrieve values from Task objects", "Use response data from read operations", "Create a client", "Retrieve a client", "Update a client", "Delete a client", "Helper methods for CRUD operations", "Retrieve associated groups", "Retrieve associated matters", "Retrieve associated users", "Retrieve available statuses", "Methods for client domain activation keys", "Create client domain activation key", "Submit a client domain activation key", "Retry activating a client domain" ], "name": "Client Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Client Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Client_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Client_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Client Manager (REST)", "Guidelines for the Client Manager service", "URLs", "Postman sample file", "Client code sample", "Create a client", "Retrieve a client", "Update a client", "Delete a client", "Helper endpoints for CRUD operations", "Retrieve associated groups", "Retrieve associated matters", "Retrieve associated users", "Retrieve available statuses", "Endpoints for client domain activation keys", "Create client domain activation key", "Submit a client domain activation key", "Retry activating a client domain" ], "headings": [ "Client Manager (REST)", "Guidelines for the Client Manager service", "URLs", "Postman sample file", "Client code sample", "Create a client", "Retrieve a client", "Update a client", "Delete a client", "Helper endpoints for CRUD operations", "Retrieve associated groups", "Retrieve associated matters", "Retrieve associated users", "Retrieve available statuses", "Endpoints for client domain activation keys", "Create client domain activation key", "Submit a client domain activation key", "Retry activating a client domain" ], "name": "Client Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Client Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Federated_instance_manager__.NET_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Federated_instance_manager__.NET_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Federated Instance Manager (.NET)", "Fundamentals for the Federated Instance Manager API", "Guidelines for the Federated Instance Manager API", "Calls to the UpdateAsync() method", "Code sample" ], "headings": [ "Federated Instance Manager (.NET)", "Fundamentals for the Federated Instance Manager API", "Guidelines for the Federated Instance Manager API", "Calls to the UpdateAsync() method", "Code sample" ], "name": "Federated Instance Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Federated Instance Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Federated_instance_manager__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Federated_instance_manager__REST_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Federated Instance Manager (REST)", "Guidelines for the Federated Instance Manager service", "URLs", "Required permissions", "Create a federated instance", "Retrieve a single federated instance", "Retrieve all federated instances", "Update a federated instance", "Delete a federated instance" ], "headings": [ "Federated Instance Manager (REST)", "Guidelines for the Federated Instance Manager service", "URLs", "Required permissions", "Create a federated instance", "Retrieve a single federated instance", "Retrieve all federated instances", "Update a federated instance", "Delete a federated instance" ], "name": "Federated Instance Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Federated Instance Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Group_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Group_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Group Manager (.NET)", "Fundamentals for the Group Manager API", "Methods", "Classes", "Create a group", "Retrieve a group", "Update a group", "Delete a group", "Query for group members", "Add users to a group", "Remove users from a group", "Helper methods for users and clients", "Query for clients to associate with a group", "Query for users to add to a group", "Query for groups assigned to a user", "Mass operations on groups", "Add multiple users to multiple groups", "Remove multiple users from multiple groups" ], "headings": [ "Group Manager (.NET)", "Fundamentals for the Group Manager API", "Methods", "Classes", "Create a group", "Retrieve a group", "Update a group", "Delete a group", "Query for group members", "Add users to a group", "Remove users from a group", "Helper methods for users and clients", "Query for clients to associate with a group", "Query for users to add to a group", "Query for groups assigned to a user", "Mass operations on groups", "Add multiple users to multiple groups", "Remove multiple users from multiple groups" ], "name": "Group Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Group Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Group_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Group_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Group Manager (REST)", "Guidelines for the Group Manager service", "URLs", "Client code sample", "Create a group", "Retrieve a group", "Update a group", "Delete a group", "Add users to a group", "Remove users from a group", "Helper methods for users and clients", "Query for clients to associate with a group", "Query for users to add to a group", "Query for group members", "Query groups assigned to a user", "Mass operations on groups", "Add multiple users to multiple groups", "Remove multiple users from multiple groups" ], "headings": [ "Group Manager (REST)", "Guidelines for the Group Manager service", "URLs", "Client code sample", "Create a group", "Retrieve a group", "Update a group", "Delete a group", "Add users to a group", "Remove users from a group", "Helper methods for users and clients", "Query for clients to associate with a group", "Query for users to add to a group", "Query for group members", "Query groups assigned to a user", "Mass operations on groups", "Add multiple users to multiple groups", "Remove multiple users from multiple groups" ], "name": "Group Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Group Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Identity.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Identity.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Identity (authentication and user accounts)", "General concepts", "Authentication provider types and login profiles", "Client manager", "Federated instance manager", "Group manager", "Permissions manager", "User manager", "Current Identity API content", "Version History" ], "headings": [ "Identity (authentication and user accounts)", "General concepts", "Authentication provider types and login profiles", "Client manager", "Federated instance manager", "Group manager", "Permissions manager", "User manager", "Current Identity API content", "Version History" ], "name": "Identity (authentication and user accounts)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Identity (authentication and user accounts)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Identity_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Identity_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for Relativity Identity, provided in the Relativity.Identity.SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Identity .NET API Reference", "Relativity.Identity.SDK" ], "headings": [ "Relativity Identity .NET API Reference", "Relativity.Identity.SDK" ], "name": "Relativity Identity .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for Relativity Identity, provided in the Relativity.Identity.SDK.", "title": "Relativity Identity .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Identity_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Identity_REST_API_Reference.htm" }, "description": "Browse the Relativity Identity REST API reference for the Relativity-Identity service, including its endpoints and the OAS file.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Identity REST API Reference", "Relativity-Identity" ], "headings": [ "Relativity Identity REST API Reference", "Relativity-Identity" ], "name": "Relativity Identity REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Relativity Identity REST API reference for the Relativity-Identity service, including its endpoints and the OAS file.", "title": "Relativity Identity REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/IdentityNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/IdentityNETAPI.html" }, "description": "Relativity Identity .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity Identity .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity Identity .NET API Reference", "title": "Relativity Identity .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/IdentityRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/IdentityRESTAPI.html" }, "description": "Relativity Identity REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity Identity REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity Identity REST API Reference", "title": "Relativity Identity REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Login_profile_manager__.NET_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Login_profile_manager__.NET_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Login Profile Manager (.NET)", "Fundamentals for the Login Profile Manager API", "Guidelines for the Login Profile Manager API", "Read a user login profile and create a login method" ], "headings": [ "Login Profile Manager (.NET)", "Fundamentals for the Login Profile Manager API", "Guidelines for the Login Profile Manager API", "Read a user login profile and create a login method" ], "name": "Login Profile Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Login Profile Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Login_profile_manager__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Login_profile_manager__REST_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Login Profile Manager (REST)", "Guidelines for the Login Profile Manager service", "URLs", "Get global authentication profile", "Update an authentication profile", "Get a login profile for a user", "Update a login profile for a user", "Helper endpoints for invitation emails", "Verify that invitation emails can be sent successfully", "Send a single invitation email", "Send bulk invitations to users", "Set a user\u0027s password", "Reset authenticator secret (2FA)" ], "headings": [ "Login Profile Manager (REST)", "Guidelines for the Login Profile Manager service", "URLs", "Get global authentication profile", "Update an authentication profile", "Get a login profile for a user", "Update a login profile for a user", "Helper endpoints for invitation emails", "Verify that invitation emails can be sent successfully", "Send a single invitation email", "Send bulk invitations to users", "Set a user\u0027s password", "Reset authenticator secret (2FA)" ], "name": "Login Profile Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Login Profile Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2_Client_Manager__.NET_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2_Client_Manager__.NET_.htm" }, "description": "The OAuth2Client Manager API exposes CRUD operations for OAuth2 clients through .NET. It also supports generating secrets for OAuth2 clients.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "OAuth2 Client Manager (.NET)", "Fundamentals for the OAuth2 Client Manager API", "Guidelines for the OAuth2 Client\u0026#160;Manager API", "Create an OAuth2 client", "Update an OAuth2 client", "Regenerate a client secret" ], "headings": [ "OAuth2 Client Manager (.NET)", "Fundamentals for the OAuth2 Client Manager API", "Guidelines for the OAuth2 Client\u0026#160;Manager API", "Create an OAuth2 client", "Update an OAuth2 client", "Regenerate a client secret" ], "name": "OAuth2 Client Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The OAuth2Client Manager API exposes CRUD operations for OAuth2 clients through .NET. It also supports generating secrets for OAuth2 clients.", "title": "OAuth2 Client Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2_Client_Manager__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2_Client_Manager__REST_.htm" }, "description": "The OAuth2Client Manager API exposes CRUD operations for OAuth2 clients through REST. It also supports generating secrets for OAuth2 clients.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "OAuth2 Client Manager (REST)", "Guidelines for the OAuth2 Client Manager service", "URLs", "Create an OAuth2 client", "Create a client with flow and redirectUrs", "Create a client with OAuth2Client object", "Update an OAuth2 client", "Delete an OAuth2 client", "Regenerate a client secret" ], "headings": [ "OAuth2 Client Manager (REST)", "Guidelines for the OAuth2 Client Manager service", "URLs", "Create an OAuth2 client", "Create a client with flow and redirectUrs", "Create a client with OAuth2Client object", "Update an OAuth2 client", "Delete an OAuth2 client", "Regenerate a client secret" ], "name": "OAuth2 Client Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The OAuth2Client Manager API exposes CRUD operations for OAuth2 clients through REST. It also supports generating secrets for OAuth2 clients.", "title": "OAuth2 Client Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2_Client_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2_Client_NET_API_Reference.htm" }, "description": "Browse the Relativity OAuth2 Client .NET API reference for the Relativity.OAuth2.Client SDK, including its types and members.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity OAuth2 Client .NET API Reference", "Relativity.OAuth2.Client" ], "headings": [ "Relativity OAuth2 Client .NET API Reference", "Relativity.OAuth2.Client" ], "name": "Relativity OAuth2 Client .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Relativity OAuth2 Client .NET API reference for the Relativity.OAuth2.Client SDK, including its types and members.", "title": "Relativity OAuth2 Client .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2ClientNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/OAuth2ClientNETAPI.html" }, "description": "Relativity OAuth2 Client .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity OAuth2 Client .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity OAuth2 Client .NET API Reference", "title": "Relativity OAuth2 Client .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permission_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permission_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Permission Manager (.NET)", "Permissions fundamentals", "Typical use cases", "Modify permissions for a group", "Apply item level security for specific objects", "Get Permissions for logged in user", "Work with individual permissions", "Permission objects", "Query permissions", "Read a permission", "Read the current user and group permission values", "Set permission values", "Custom permissions", "Create a permission", "Read a permission", "Update a permission", "Delete a permission", "Add and remove groups to permissions", "Admin groups", "Workspace groups", "Item groups", "Enable item-level security", "Get item-level security", "Set item-level security", "Set group permissions", "Admin group permissions", "Workspace group permissions", "Item group permissions", "User lookup in groups", "Get admin group users", "Get workspace group users", "Get item group users" ], "headings": [ "Permission Manager (.NET)", "Permissions fundamentals", "Typical use cases", "Modify permissions for a group", "Apply item level security for specific objects", "Get Permissions for logged in user", "Work with individual permissions", "Permission objects", "Query permissions", "Read a permission", "Read the current user and group permission values", "Set permission values", "Custom permissions", "Create a permission", "Read a permission", "Update a permission", "Delete a permission", "Add and remove groups to permissions", "Admin groups", "Workspace groups", "Item groups", "Enable item-level security", "Get item-level security", "Set item-level security", "Set group permissions", "Admin group permissions", "Workspace group permissions", "Item group permissions", "User lookup in groups", "Get admin group users", "Get workspace group users", "Get item group users" ], "name": "Permission Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Permission Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permission_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permission_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Permission Manager (REST)", "Client code sample", "Get admin groups", "Get workspace groups", "Get item groups", "Add and remove admin groups", "Add and remove workspace groups", "Add and remove item groups", "Get admin permissions", "Get workspace permissions", "Get item permissions", "Set admin permissions", "Set workspace permissions", "Get item-level security", "GetItemLevelSecurityAsync", "GetItemLevelSecurityListAsync", "Set item-level security", "Set item permissions", "Get admin group users", "Get workspace group users", "Get item group users", "Query permissions", "Read a single permission", "Get selected permissions for current user", "GetPermissionSelectedAsync", "GetPermissionSelectedListAsync", "Get selected permissions for a group", "Set selected permissions for a group", "Create a custom permission", "Update a custom permission", "Delete a custom permission" ], "headings": [ "Permission Manager (REST)", "Client code sample", "Get admin groups", "Get workspace groups", "Get item groups", "Add and remove admin groups", "Add and remove workspace groups", "Add and remove item groups", "Get admin permissions", "Get workspace permissions", "Get item permissions", "Set admin permissions", "Set workspace permissions", "Get item-level security", "GetItemLevelSecurityAsync", "GetItemLevelSecurityListAsync", "Set item-level security", "Set item permissions", "Get admin group users", "Get workspace group users", "Get item group users", "Query permissions", "Read a single permission", "Get selected permissions for current user", "GetPermissionSelectedAsync", "GetPermissionSelectedListAsync", "Get selected permissions for a group", "Set selected permissions for a group", "Create a custom permission", "Update a custom permission", "Delete a custom permission" ], "name": "Permission Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Permission Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permissions_access_control_API__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permissions_access_control_API__REST_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Permissions access control API", "Guidelines for the permissions access control API", "URL address format", "Considerations", "Authentication requirements", "Token requirements", "Identifier guide", "Node Key", "Group ID (groupId)", "Role Key (roleKey)", "Typical use cases", "List current role assignments on a fileshare", "Batch assign and revoke roles on a fileshare", "List current role assignments on the tenant", "Batch assign and revoke roles on the tenant" ], "headings": [ "Permissions access control API", "Guidelines for the permissions access control API", "URL address format", "Considerations", "Authentication requirements", "Token requirements", "Identifier guide", "Node Key", "Group ID (groupId)", "Role Key (roleKey)", "Typical use cases", "List current role assignments on a fileshare", "Batch assign and revoke roles on a fileshare", "List current role assignments on the tenant", "Batch assign and revoke roles on the tenant" ], "name": "Permissions access control API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Permissions access control API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permissions_access_control_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/Permissions_access_control_REST_API_Reference.htm" }, "description": "Browse the Permissions access control REST API reference for endpoint details on managing role assignments.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Permissions access control REST API Reference", "Permissions access control" ], "headings": [ "Permissions access control REST API Reference", "Permissions access control" ], "name": "Permissions access control", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Permissions access control REST API reference for endpoint details on managing role assignments.", "title": "Permissions access control" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/PermissionsaccesscontrolRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/PermissionsaccesscontrolRESTAPI.html" }, "description": "Permissions access control REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Permissions access control REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Permissions access control REST API Reference", "title": "Permissions access control REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/User_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/User_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "User Manager (.NET)", "Fundamentals for the User Manager API", "Guidelines for the User Manager API", "Create a user", "Retrieve metadata for a user", "Retrieve settings for the current user", "Update properties for a user", "Update settings for the current user", "Delete a user", "Helper methods for querying on users", "Retrieve all available types for users", "Retrieve all users for a workspace", "Query for users in a workspace" ], "headings": [ "User Manager (.NET)", "Fundamentals for the User Manager API", "Guidelines for the User Manager API", "Create a user", "Retrieve metadata for a user", "Retrieve settings for the current user", "Update properties for a user", "Update settings for the current user", "Delete a user", "Helper methods for querying on users", "Retrieve all available types for users", "Retrieve all users for a workspace", "Query for users in a workspace" ], "name": "User Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "User Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/User_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Identity/User_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "User Manager (REST)", "Guidelines for the User Manager service", "URLs", "Client code sample", "Create a user", "Retrieve metadata for a user", "Retrieve settings for the current user", "Update properties for a user", "Update settings for the current user", "Delete a user", "Helper endpoints for querying on users", "Retrieve available types for users", "Query for groups to associate with users", "Retrieve information about the current user", "Retrieve all users in a workspace", "Retrieve active users in a workspace", "Retrieve users in workspace with Relativity access", "Query for users in a workspace" ], "headings": [ "User Manager (REST)", "Guidelines for the User Manager service", "URLs", "Client code sample", "Create a user", "Retrieve metadata for a user", "Retrieve settings for the current user", "Update properties for a user", "Update settings for the current user", "Delete a user", "Helper endpoints for querying on users", "Retrieve available types for users", "Query for groups to associate with users", "Retrieve information about the current user", "Retrieve all users in a workspace", "Retrieve active users in a workspace", "Retrieve users in workspace with Relativity access", "Query for users in a workspace" ], "name": "User Manager", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "User Manager" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Imaging", "Current Imaging API content", "Version History" ], "headings": [ "Imaging", "Current Imaging API content", "Version History" ], "name": "Imaging Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Imaging Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_API.htm" }, "description": "Use the Imaging .NET API to run and cancel imaging jobs and manage imaging profiles, sets, and application field codes programmatically.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Imaging (.NET)", "Imaging API fundamentals", "SDK for Imaging API", "Imaging Profile Manager", "Imaging Set Manager", "Native Type Manager", "Application Field Code Manager", "Imaging Job Manager", "Document Status Manager", "Imaging Environment Manager" ], "headings": [ "Imaging (.NET)", "Imaging API fundamentals", "SDK for Imaging API", "Imaging Profile Manager", "Imaging Set Manager", "Native Type Manager", "Application Field Code Manager", "Imaging Job Manager", "Document Status Manager", "Imaging Environment Manager" ], "name": "Imaging (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Imaging .NET API to run and cancel imaging jobs and manage imaging profiles, sets, and application field codes programmatically.", "title": "Imaging (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_API_services_for_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_API_services_for_REST.htm" }, "description": "Use the Imaging REST services to automate imaging jobs, profiles, sets, and native types, and review the guidelines for calling them over HTTP.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Imaging API (REST)", "Guidelines for the Imaging services", "URLs", "Imaging Profile Manager", "Imaging Set Manager", "Native Type Manager", "Application Field Code Manager", "Imaging Job Manager", "Document Status Manager", "Imaging Environment Manager" ], "headings": [ "Imaging API (REST)", "Guidelines for the Imaging services", "URLs", "Imaging Profile Manager", "Imaging Set Manager", "Native Type Manager", "Application Field Code Manager", "Imaging Job Manager", "Document Status Manager", "Imaging Environment Manager" ], "name": "Imaging (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Imaging REST services to automate imaging jobs, profiles, sets, and native types, and review the guidelines for calling them over HTTP.", "title": "Imaging (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_NET_API_Reference.htm" }, "description": "Browse the Imaging .NET API reference for the Relativity.Imaging.SDK, including its interfaces and classes.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Imaging .NET API Reference", "Relativity.Imaging.SDK" ], "headings": [ "Imaging .NET API Reference", "Relativity.Imaging.SDK" ], "name": "Imaging .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Imaging .NET API reference for the Relativity.Imaging.SDK, including its interfaces and classes.", "title": "Imaging .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/Imaging_REST_API_Reference.htm" }, "description": "Browse the Imaging REST API reference for the relativity-imaging service and its endpoints.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Imaging REST API Reference", "relativity-imaging" ], "headings": [ "Imaging REST API Reference", "relativity-imaging" ], "name": "Imaging REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Imaging REST API reference for the relativity-imaging service and its endpoints.", "title": "Imaging REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/ImagingNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/ImagingNETAPI.html" }, "description": "Imaging .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Imaging .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Imaging .NET API Reference", "title": "Imaging .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/ImagingRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Imaging/ImagingRESTAPI.html" }, "description": "Imaging REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Imaging REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Imaging REST API Reference", "title": "Imaging REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Infrastructure.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Infrastructure.htm" }, "description": "Find the Infrastructure business domain landing page, with links to the Infrastructure SDK, Notifications Manager (MotD), and Resource Server and Resource Pool API content.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Infrastructure", "Current Infrastructure API documentation", "Version History" ], "headings": [ "Infrastructure", "Current Infrastructure API documentation", "Version History" ], "name": "Infrastructure Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the Infrastructure business domain landing page, with links to the Infrastructure SDK, Notifications Manager (MotD), and Resource Server and Resource Pool API content.", "title": "Infrastructure Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Infrastructure_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Infrastructure_NET_API_Reference.htm" }, "description": "Browse the Infrastructure .NET API reference for the Relativity.Infrastructure.SDK, including its interfaces and classes.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Infrastructure .NET API Reference", "Relativity.Infrastructure.SDK" ], "headings": [ "Infrastructure .NET API Reference", "Relativity.Infrastructure.SDK" ], "name": "Infrastructure .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Infrastructure .NET API reference for the Relativity.Infrastructure.SDK, including its interfaces and classes.", "title": "Infrastructure .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/InfrastructureNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/InfrastructureNETAPI.html" }, "description": "Infrastructure .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Infrastructure .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Infrastructure .NET API Reference", "title": "Infrastructure .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Notifications_Manager_API__MotD_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Notifications_Manager_API__MotD_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Notifications Manager (MotD) - (.NET)", "Fundamentals for the Notifications Manager API", "Methods", "Classes", "Read the MotD", "Update the MotD", "Dismiss the MotD", "Has Dismissed the MotD", "Display the MotD" ], "headings": [ "Notifications Manager (MotD) - (.NET)", "Fundamentals for the Notifications Manager API", "Methods", "Classes", "Read the MotD", "Update the MotD", "Dismiss the MotD", "Has Dismissed the MotD", "Display the MotD" ], "name": "Notifications Manager (MotD) - (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Notifications Manager (MotD) - (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Notifications_Manager_service__MotD_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Notifications_Manager_service__MotD_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Notifications Manager (MotD) - (REST)", "Guidelines for the Notifications Manager service", "URLs", "Postman sample file", "Client code sample", "Read a MotD", "Update a MotD", "Dismiss a MotD", "Check for the dismissal of a MotD", "Check for text or HTML format of a MotD" ], "headings": [ "Notifications Manager (MotD) - (REST)", "Guidelines for the Notifications Manager service", "URLs", "Postman sample file", "Client code sample", "Read a MotD", "Update a MotD", "Dismiss a MotD", "Check for the dismissal of a MotD", "Check for text or HTML format of a MotD" ], "name": "Notifications Manager (MotD) - (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Notifications Manager (MotD) - (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Notifications_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Notifications_REST_API_Reference.htm" }, "description": "Browse the Notifications REST API reference for the relativity-notifications service and its endpoints.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Notifications REST API Reference", "relativity-notifications" ], "headings": [ "Notifications REST API Reference", "relativity-notifications" ], "name": "Notifications REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Notifications REST API reference for the relativity-notifications service and its endpoints.", "title": "Notifications REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/NotificationsRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/NotificationsRESTAPI.html" }, "description": "Notifications REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Notifications REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Notifications REST API Reference", "title": "Notifications REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Resource_Server_Resource_Pool_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Resource_Server_Resource_Pool_API.htm" }, "description": "Use the Resource Server and Resource Pool APIs through .NET or REST to check server status, manage agents, restart services, and manage server credentials.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Resource Server / Resource Pool (.NET / REST)", "Resource Server / Resource Pool fundamentals", "Overview", "REST\u0026#160;guidelines", "Server types" ], "headings": [ "Resource Server / Resource Pool (.NET / REST)", "Resource Server / Resource Pool fundamentals", "Overview", "REST\u0026#160;guidelines", "Server types" ], "name": "Resource Server / Resource Pool (.NET / REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Resource Server and Resource Pool APIs through .NET or REST to check server status, manage agents, restart services, and manage server credentials.", "title": "Resource Server / Resource Pool (.NET / REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Resource_Server_Resource_Pool_REST_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/Resource_Server_Resource_Pool_REST_API.htm" }, "description": "Browse the Resource Server and Resource Pool REST API reference, including endpoint documentation and the OAS file.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Resource Server Resource Pool REST Reference", "headings": "Resource Server Resource Pool REST Reference", "name": "Resource Server Resource Pool REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Resource Server and Resource Pool REST API reference, including endpoint documentation and the OAS file.", "title": "Resource Server Resource Pool REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/ResourceServerResourcePoolRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Infrastructure/ResourceServerResourcePoolRESTAPI.html" }, "description": "Resource Server Resource Pool REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Resource Server Resource Pool REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Resource Server Resource Pool REST Reference", "title": "Resource Server Resource Pool REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Keyword_Search/Keyword_Search.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Keyword_Search/Keyword_Search.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Keyword Search", "Keyword Search changelog", "Current Keyword Search API content" ], "headings": [ "Keyword Search", "Keyword Search changelog", "Current Keyword Search API content" ], "name": "Keyword Search Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Keyword Search Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Keyword_Search/Keyword_Search_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Keyword_Search/Keyword_Search_Manager_API.htm" }, "description": "Keyword search (or SQL index search) is Relativity\u0027s default search engine. You can use a keyword search to query a full text index. For more information, see Keyword search in the Relativity Documentation site. The Services API supports the create, read, update, delete, and query operations on a KeywordSearch 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 perform the operations on KeywordSearch DTOs asynchronously. Note that asynchronous operations return a standard .NET\u0026#160;System.Threading.Tasks.Task\u0026amp;lt;TResult\u0026amp;gt; object that can be used to monitor progress and interact with the process.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Keyword Search Manager (.NET) for saved searches", "KeywordSearch properties", "Create a KeywordSearch", "Read KeywordSearch", "Update KeywordSearch", "Delete KeywordSearch", "Query KeywordSearches", "Helper methods", "Email a link to KeywordSearch", "Move KeywordSearch", "Copy KeywordSearch", "Exception handling", "ServiceException", "ValidationException" ], "headings": [ "Keyword Search Manager (.NET) for saved searches", "KeywordSearch properties", "Create a KeywordSearch", "Read KeywordSearch", "Update KeywordSearch", "Delete KeywordSearch", "Query KeywordSearches", "Helper methods", "Email a link to KeywordSearch", "Move KeywordSearch", "Copy KeywordSearch", "Exception handling", "ServiceException", "ValidationException" ], "name": "Keyword Search Manager (.NET) for saved searches", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Keyword search (or SQL index search) is Relativity\u0027s default search engine. You can use a keyword search to query a full text index. For more information, see Keyword search in the Relativity Documentation site. The Services API supports the create, read, update, delete, and query operations on a KeywordSearch 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 perform the operations on KeywordSearch DTOs asynchronously. Note that asynchronous operations return a standard .NET\u0026#160;System.Threading.Tasks.Task\u0026amp;lt;TResult\u0026amp;gt; object that can be used to monitor progress and interact with the process.", "title": "Keyword Search Manager (.NET) for saved searches" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Keyword_Search/Keyword_Search_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Keyword_Search/Keyword_Search_Manager_service.htm" }, "description": "This topic describes how to interact with the Relativity saved keyword search using the REST API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Keyword Search Manager (REST) for saved searches", "Client code sample", "Create", "Search condition criteria", "Read", "Update", "Delete", "Query", "Move", "Copy", "Helper operations", "GetEmailToLinkUrlAsync", "GetFieldsForCriteriaConditionAsync", "GetFieldsForObjectCriteriaCollectionAsync", "GetFieldsForSearchResultViewAsync", "GetSearchIncludesAsync", "GetSearchOwnersAsync", "GetAccessStatusAsync" ], "headings": [ "Keyword Search Manager (REST) for saved searches", "Client code sample", "Create", "Search condition criteria", "Read", "Update", "Delete", "Query", "Move", "Copy", "Helper operations", "GetEmailToLinkUrlAsync", "GetFieldsForCriteriaConditionAsync", "GetFieldsForObjectCriteriaCollectionAsync", "GetFieldsForSearchResultViewAsync", "GetSearchIncludesAsync", "GetSearchOwnersAsync", "GetAccessStatusAsync" ], "name": "Keyword Search Manager (REST) for saved searches", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This topic describes how to interact with the Relativity saved keyword search using the REST API.", "title": "Keyword Search Manager (REST) for saved searches" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations.htm" }, "description": "Find the Mass Operations landing page, with supported bulk operations, considerations, links to the .NET and REST content, and version history.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Mass Operations", "Considerations", "Current Mass Operations API content", "Version History" ], "headings": [ "Mass Operations", "Considerations", "Current Mass Operations API content", "Version History" ], "name": "Mass Operations Business Domain", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the Mass Operations landing page, with supported bulk operations, considerations, links to the .NET and REST content, and version history.", "title": "Mass Operations Business Domain" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Mass Operations (.NET)", "Code Samples", "Mass copy", "Mass move", "Mass edit", "Mass delete", "Mass replace", "Save-as-list", "Tally/sum/average", "Export to file", "Return state information for a specific operation", "Cancel a specific operation", "Considerations" ], "headings": [ "Mass Operations (.NET)", "Code Samples", "Mass copy", "Mass move", "Mass edit", "Mass delete", "Mass replace", "Save-as-list", "Tally/sum/average", "Export to file", "Return state information for a specific operation", "Cancel a specific operation", "Considerations" ], "name": "Mass Operations (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Mass Operations (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_NET_API_Reference.htm" }, "description": "Browse the Mass Operations .NET API reference for the Relativity.MassOperations.SDK, including its interfaces and classes.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Mass Operations .NET API Reference", "Relativity.MassOperations.SDK" ], "headings": [ "Mass Operations .NET API Reference", "Relativity.MassOperations.SDK" ], "name": "Mass Operations .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Mass Operations .NET API reference for the Relativity.MassOperations.SDK, including its interfaces and classes.", "title": "Mass Operations .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_REST_API_Reference.htm" }, "description": "Browse the Mass Operations REST API reference for the relativity-massoperation service and its endpoints.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Mass Operations REST API Reference", "relativity-massoperation" ], "headings": [ "Mass Operations REST API Reference", "relativity-massoperation" ], "name": "Mass Operations REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Mass Operations REST API reference for the relativity-massoperation service and its endpoints.", "title": "Mass Operations REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_Service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/Mass_Operations_Service.htm" }, "description": "Use the Mass Operations REST service (relativity-massoperation) for bulk processing of documents and RDOs, with its base route, methods, and request models.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Mass Operations (REST)", "headings": "Mass Operations (REST)", "name": "Mass Operations (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Mass Operations REST service (relativity-massoperation) for bulk processing of documents and RDOs, with its base route, methods, and request models.", "title": "Mass Operations (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/MassOperationsNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/MassOperationsNETAPI.html" }, "description": "Mass Operations .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Mass Operations .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Mass Operations .NET API Reference", "title": "Mass Operations .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/MassOperationsRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Mass_Operations/MassOperationsRESTAPI.html" }, "description": "Mass Operations REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Mass Operations REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Mass Operations REST Reference", "title": "Mass Operations REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications.htm" }, "description": "Learn about the Relativity Notifications APIs for sending email, including prerequisites, sender behavior, and links to the .NET and REST topics.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Notifications", "Current Notifications API content", "Using the Notifications Service", "Prerequisites", "Sender", "Sending Email Notifications", "Troubleshooting", "Version History" ], "headings": [ "Notifications", "Current Notifications API content", "Using the Notifications Service", "Prerequisites", "Sender", "Sending Email Notifications", "Troubleshooting", "Version History" ], "name": "Notifications", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn about the Relativity Notifications APIs for sending email, including prerequisites, sender behavior, and links to the .NET and REST topics.", "title": "Notifications" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications__.NET_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications__.NET_.htm" }, "description": "Use the Relativity.Notifications .NET API to send email notifications through the Relativity SMTP client, with the EmailNotificationRequest object and a code sample.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Notifications (.NET)", "Code Samples" ], "headings": [ "Notifications (.NET)", "Code Samples" ], "name": "Notifications (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Relativity.Notifications .NET API to send email notifications through the Relativity SMTP client, with the EmailNotificationRequest object and a code sample.", "title": "Notifications (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications__REST_.htm" }, "description": "Use the Notifications REST service to send email notifications through Relativity, with the endpoint URL and sample JSON request and response.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Notifications (REST)", "Code Samples" ], "headings": [ "Notifications (REST)", "Code Samples" ], "name": "Notifications (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Notifications REST service to send email notifications through Relativity, with the endpoint URL and sample JSON request and response.", "title": "Notifications (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/Notifications_NET_API_Reference.htm" }, "description": "Browse the Notifications .NET API reference for the Relativity.Notifications.SDK, including its interfaces and classes.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Notifications .NET API Reference", "Relativity.Notifications.SDK" ], "headings": [ "Notifications .NET API Reference", "Relativity.Notifications.SDK" ], "name": "Notifications .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Notifications .NET API reference for the Relativity.Notifications.SDK, including its interfaces and classes.", "title": "Notifications .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/NotificationsNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Notifications/NotificationsNETAPI.html" }, "description": "Notifications .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Notifications .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Notifications .NET API Reference", "title": "Notifications .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Migrating_code_to_the_Object_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Migrating_code_to_the_Object_Manager_API.htm" }, "description": "Use this migration guide to upgrade legacy code using older versions of the Object Manager API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Migrating code to the Object Manager API", "Legacy code sample using the Object Query Manager API", "Updated code sample using the Object Manager API" ], "headings": [ "Migrating code to the Object Manager API", "Legacy code sample using the Object Query Manager API", "Updated code sample using the Object Manager API" ], "name": "Migrating code to the Object Manager API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use this migration guide to upgrade legacy code using older versions of the Object Manager API.", "title": "Migrating code to the Object Manager API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager.htm" }, "description": "Find the Object Manager landing page for creating, reading, updating, deleting, and querying Relativity objects, with changelog, content links, and version history.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Manager", "Current Object Manager API content", "Version History" ], "headings": [ "Object Manager", "Current Object Manager API content", "Version History" ], "name": "Object Manager Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the Object Manager landing page for creating, reading, updating, deleting, and querying Relativity objects, with changelog, content links, and version history.", "title": "Object Manager Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Manager (.NET)", "Fundamentals for the Object Manager service", "Methods", "Classes for general functionality", "Classes for retrieving dependency lists", "Classes for mass operations", "Classes for working with hydrated objects", "Classes used for export operations", "Exceptions", "Guidelines for using the Object Manager service", "Rate limit", "Use tokens with long text fields", "IObjectManager instance", "Supported field types", "Propagation", "Event handlers", "Indexers on the RelativityObject class", "Create an RDO and its specified fields", "Mass create RDOs", "Retrieve field values for a Document object or RDO", "Update field values on a Document object or RDO", "Update field values on a single object", "Update field values on a multiple object", "Update a long text field using an input stream in .NET", "Mass update Document objects or RDOs", "Mass update operation using query conditions", "Mass update operation using identifiers", "Mass update operation using objects", "Retrieve a list of object dependencies", "Delete a Document object or RDO", "Mass delete Document objects or RDOs", "Mass delete operation using query conditions", "Mass delete operation using identifiers", "Query for Relativity objects", "Parameter descriptions for query methods", "Export API", "Export API workflow", "Set up an export job", "Retrieve objects", "Stream text", "Export API code sample", "Export API Helper library" ], "headings": [ "Object Manager (.NET)", "Fundamentals for the Object Manager service", "Methods", "Classes for general functionality", "Classes for retrieving dependency lists", "Classes for mass operations", "Classes for working with hydrated objects", "Classes used for export operations", "Exceptions", "Guidelines for using the Object Manager service", "Rate limit", "Use tokens with long text fields", "IObjectManager instance", "Supported field types", "Propagation", "Event handlers", "Indexers on the RelativityObject class", "Create an RDO and its specified fields", "Mass create RDOs", "Retrieve field values for a Document object or RDO", "Update field values on a Document object or RDO", "Update field values on a single object", "Update field values on a multiple object", "Update a long text field using an input stream in .NET", "Mass update Document objects or RDOs", "Mass update operation using query conditions", "Mass update operation using identifiers", "Mass update operation using objects", "Retrieve a list of object dependencies", "Delete a Document object or RDO", "Mass delete Document objects or RDOs", "Mass delete operation using query conditions", "Mass delete operation using identifiers", "Query for Relativity objects", "Parameter descriptions for query methods", "Export API", "Export API workflow", "Set up an export job", "Retrieve objects", "Stream text", "Export API code sample", "Export API Helper library" ], "name": "Object Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Object Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_NET_API_Reference.htm" }, "description": "Browse the Object Manager SDK .NET API reference for the Relativity.ObjectManager.SDK, including its interfaces and classes.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Manager SDK .NET API Reference", "Relativity.ObjectManager.SDK" ], "headings": [ "Object Manager SDK .NET API Reference", "Relativity.ObjectManager.SDK" ], "name": "Object Manager SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Object Manager SDK .NET API reference for the Relativity.ObjectManager.SDK, including its interfaces and classes.", "title": "Object Manager SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_REST_API_Reference.htm" }, "description": "Browse the Object Manager REST API reference for the Relativity.ObjectManager service and its endpoints.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Manager REST API Reference", "Relativity.ObjectManager" ], "headings": [ "Object Manager REST API Reference", "Relativity.ObjectManager" ], "name": "Object Manager REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Object Manager REST API reference for the Relativity.ObjectManager service and its endpoints.", "title": "Object Manager REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Object_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Manager (REST)", "Rate limit", "Testing the rate limit", "Guidelines for the Object Manager service", "Postman sample file", "Client code sample", "Create an RDO", "Mass create RDOs", "Retrieve field values for a Document object or RDO", "Update fields on a Document object or RDO", "Update a long text field using an input stream", "Update a long text field using Postman", "Mass update Document objects or RDOs", "Retrieve a list of object dependencies", "Delete a Document object or RDO", "Mass delete Document objects or RDOs", "Query for Relativity objects", "Export API", "Set up an export job", "Retrieve objects", "Stream text", "Status and Error Codes" ], "headings": [ "Object Manager (REST)", "Rate limit", "Testing the rate limit", "Guidelines for the Object Manager service", "Postman sample file", "Client code sample", "Create an RDO", "Mass create RDOs", "Retrieve field values for a Document object or RDO", "Update fields on a Document object or RDO", "Update a long text field using an input stream", "Update a long text field using Postman", "Mass update Document objects or RDOs", "Retrieve a list of object dependencies", "Delete a Document object or RDO", "Mass delete Document objects or RDOs", "Query for Relativity objects", "Export API", "Set up an export job", "Retrieve objects", "Stream text", "Status and Error Codes" ], "name": "Object Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Object Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/ObjectManagerNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/ObjectManagerNETAPI.html" }, "description": "Object Manager SDK .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Object Manager SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Object Manager SDK .NET API Reference", "title": "Object Manager SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/ObjectManagerRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/ObjectManagerRESTAPI.html" }, "description": "Object Manager REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Object Manager REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Object Manager REST Reference", "title": "Object Manager REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Relativity_Object_Manager_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/Relativity_Object_Manager_NET_API_Reference.htm" }, "description": "Browse the Relativity Object Manager SDK .NET API reference for the Relativity.ObjectManager.SDK namespace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Manager SDK .NET API Reference", "Relativity.ObjectManager.SDK" ], "headings": [ "Object Manager SDK .NET API Reference", "Relativity.ObjectManager.SDK" ], "name": "Object Manager SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Relativity Object Manager SDK .NET API reference for the Relativity.ObjectManager.SDK namespace.", "title": "Object Manager SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/RelativityObjectManagerNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Manager/RelativityObjectManagerNETAPI.html" }, "description": "Object Manager SDK .NET API Reference", "type": "TechArticle", "dateModified": "2026-10-06", "tags": [ ], "headings": [ ], "name": "Object Manager SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Object Manager SDK .NET API Reference", "title": "Object Manager SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Choice_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Choice_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Choice Manager (.NET)", "Fundamentals for the Choice Manager API", "Guidelines for the Choice Manager API", "Create a single choice", "Mass create choices", "Read a choice", "Update a choice without a version check", "Update a choice with a version check", "Update multiple choices", "Delete a choice", "Delete multiple choices", "Sort choices", "Move choices to start or end of list", "Move choices after a specific choice in a list", "Retrieve a list of available parents", "Retrieve a list of available colors" ], "headings": [ "Choice Manager (.NET)", "Fundamentals for the Choice Manager API", "Guidelines for the Choice Manager API", "Create a single choice", "Mass create choices", "Read a choice", "Update a choice without a version check", "Update a choice with a version check", "Update multiple choices", "Delete a choice", "Delete multiple choices", "Sort choices", "Move choices to start or end of list", "Move choices after a specific choice in a list", "Retrieve a list of available parents", "Retrieve a list of available colors" ], "name": "Choice Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Choice Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Choice_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Choice_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Choice Manager (REST)", "Guidelines for the Choice Manager service", "URLs", "Postman sample file", "Client code sample", "Create a single choice", "Mass create choices", "Read a choice", "Update a choice without a version check", "Update a choice with a version check", "Mass update choices", "Delete a choice", "Mass delete choices", "Sort choices", "Move choices to the beginning or end of a list", "Move choices after a specific choice in a list", "Retrieve a list of available parents", "Retrieve a list of parents for a choice", "Retrieve a list of parents for a field", "Retrieve a list of available colors" ], "headings": [ "Choice Manager (REST)", "Guidelines for the Choice Manager service", "URLs", "Postman sample file", "Client code sample", "Create a single choice", "Mass create choices", "Read a choice", "Update a choice without a version check", "Update a choice with a version check", "Mass update choices", "Delete a choice", "Mass delete choices", "Sort choices", "Move choices to the beginning or end of a list", "Move choices after a specific choice in a list", "Retrieve a list of available parents", "Retrieve a list of parents for a choice", "Retrieve a list of parents for a field", "Retrieve a list of available colors" ], "name": "Choice Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Choice Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Document_File_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Document_File_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Document File Manager (.NET)", "Fundamentals for the Document File Manager API", "Retrieve document file information", "Download files", "Download a file by GUID", "Download a native file by Document Artifact ID" ], "headings": [ "Document File Manager (.NET)", "Fundamentals for the Document File Manager API", "Retrieve document file information", "Download files", "Download a file by GUID", "Download a native file by Document Artifact ID" ], "name": "Document File Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Document File Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Document_File_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Document_File_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Document File Manager (REST)", "Guidelines for the Document File Manager service", "URLs", "Client code sample", "Retrieve document file information", "Download files", "Download a file by GUID", "Download a native file by Document Artifact ID" ], "headings": [ "Document File Manager (REST)", "Guidelines for the Document File Manager service", "URLs", "Client code sample", "Retrieve document file information", "Download files", "Download a file by GUID", "Download a native file by Document Artifact ID" ], "name": "Document File Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Document File Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Field_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Field_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Field Manager (.NET)", "Fundamentals for Field Manager API", "Guidelines for the Field Manager API", "Supported field types", "Helper methods", "Relational fields", "Overlay behavior", "Filter types", "Source property", "Formatting fields", "Create a field", "Read a field", "Update a field", "Delete a field", "Retrieve available object types", "Retrieve available views for an object type", "Retrieve available fields for propagation", "Retrieve object types for a single object field", "Retrieve object types for a multiple object field", "Retrieve keyboard shortcuts", "Retrieve valid keys", "Retrieve the order of relational field icons" ], "headings": [ "Field Manager (.NET)", "Fundamentals for Field Manager API", "Guidelines for the Field Manager API", "Supported field types", "Helper methods", "Relational fields", "Overlay behavior", "Filter types", "Source property", "Formatting fields", "Create a field", "Read a field", "Update a field", "Delete a field", "Retrieve available object types", "Retrieve available views for an object type", "Retrieve available fields for propagation", "Retrieve object types for a single object field", "Retrieve object types for a multiple object field", "Retrieve keyboard shortcuts", "Retrieve valid keys", "Retrieve the order of relational field icons" ], "name": "Field Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Field Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Field_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Field_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Field Manager (REST)", "Guidelines for the Field Manager service", "URLs", "Supported field types", "Helper endpoints", "Relational fields", "Overlay behavior", "Filter types", "Source property", "Formatting fields", "Client code sample", "Postman sample file", "Create a field", "Read a field", "Update a field", "Delete a field", "Retrieve available object types", "Retrieve available views for an object type", "Retrieve available fields for propagation", "Retrieve object types for a single object field", "Retrieve object types for a multiple object field", "Retrieve keyboard shortcuts", "Retrieve valid keys", "Retrieve the order of relational field icons" ], "headings": [ "Field Manager (REST)", "Guidelines for the Field Manager service", "URLs", "Supported field types", "Helper endpoints", "Relational fields", "Overlay behavior", "Filter types", "Source property", "Formatting fields", "Client code sample", "Postman sample file", "Create a field", "Read a field", "Update a field", "Delete a field", "Retrieve available object types", "Retrieve available views for an object type", "Retrieve available fields for propagation", "Retrieve object types for a single object field", "Retrieve object types for a multiple object field", "Retrieve keyboard shortcuts", "Retrieve valid keys", "Retrieve the order of relational field icons" ], "name": "Field Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Field Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/File_Field_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/File_Field_Manager_API.htm" }, "description": "The File Field Manager API exposes a service for uploading and downloading files linked to file fields in .NET.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "File Field Manager (.NET)", "File Field Manager API fundamentals", "Sample workflow for file fields", "Downloading files from file fields", "Uploading files to file fields" ], "headings": [ "File Field Manager (.NET)", "File Field Manager API fundamentals", "Sample workflow for file fields", "Downloading files from file fields", "Uploading files to file fields" ], "name": "File Field Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The File Field Manager API exposes a service for uploading and downloading files linked to file fields in .NET.", "title": "File Field Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/File_Field_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/File_Field_Manager_service.htm" }, "description": "The File Field Manager API exposes a service for uploading and downloading files linked to file fields in REST.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "File Field Manager (REST)", "Guidelines for the File Field Manager service", "Postman sample file", "Client code sample", "Uploading files to file fields", "Downloading files from file fields" ], "headings": [ "File Field Manager (REST)", "Guidelines for the File Field Manager service", "Postman sample file", "Client code sample", "Uploading files to file fields", "Downloading files from file fields" ], "name": "File Field Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The File Field Manager API exposes a service for uploading and downloading files linked to file fields in REST.", "title": "File Field Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Model.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Model.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Model", "Current Object Model API content", "Version History" ], "headings": [ "Object Model", "Current Object Model API content", "Version History" ], "name": "Object Model Business Domain", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Object Model Business Domain" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Model_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Model_NET_API_Reference.htm" }, "description": "Browse the Object Model .NET API reference for the Relativity.ObjectModel.SDK, including its interfaces and classes.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Model .NET API Reference", "Relativity.ObjectModel.SDK" ], "headings": [ "Object Model .NET API Reference", "Relativity.ObjectModel.SDK" ], "name": "Object Model .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Object Model .NET API reference for the Relativity.ObjectModel.SDK, including its interfaces and classes.", "title": "Object Model .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Type_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Type_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Type Manager (.NET)", "Fundamentals for managing object types", "CRUD operations for object types", "Create an object type", "Read an object type", "Update an object type", "Delete an object type", "Retrieve parent object types" ], "headings": [ "Object Type Manager (.NET)", "Fundamentals for managing object types", "CRUD operations for object types", "Create an object type", "Read an object type", "Update an object type", "Delete an object type", "Retrieve parent object types" ], "name": "Object Type Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Object Type Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Type_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/Object_Type_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Type Manager (REST)", "Guidelines for the Object Type Manager service", "URLs", "Postman sample files", "Client code sample", "CRUD operations for object types", "Create an object type", "Read an object type", "Update an object type", "Delete an object type", "Retrieve a parent object types" ], "headings": [ "Object Type Manager (REST)", "Guidelines for the Object Type Manager service", "URLs", "Postman sample files", "Client code sample", "CRUD operations for object types", "Create an object type", "Read an object type", "Update an object type", "Delete an object type", "Retrieve a parent object types" ], "name": "Object Type Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Object Type Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/ObjectModelNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/ObjectModelNETAPI.html" }, "description": "Object Model .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Object Model .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Object Model .NET API Reference", "title": "Object Model .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/System_Artifact_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/System_Artifact_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "System Artifact Manager (.NET)", "System Artifact Manager API fundamentals", "Retrieve the Artifact ID of a system artifact" ], "headings": [ "System Artifact Manager (.NET)", "System Artifact Manager API fundamentals", "Retrieve the Artifact ID of a system artifact" ], "name": "System Artifact Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "System Artifact Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/System_Artifact_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Object_Model/System_Artifact_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "System Artifact Manager (REST)", "Guidelines for the System Artifact Manager service", "URLs", "Client code sample", "Read system artifact ID" ], "headings": [ "System Artifact Manager (REST)", "Guidelines for the System Artifact Manager service", "URLs", "Client code sample", "Read system artifact ID" ], "name": "System Artifact Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "System Artifact Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_OutsideIn/OutsideIn_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_OutsideIn/OutsideIn_NET_API_Reference.htm" }, "description": "Browse the OutsideIn .NET API reference for the Relativity.OutsideIn namespace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "OutsideIn .NET API Reference", "Relativity.OutsideIn" ], "headings": [ "OutsideIn .NET API Reference", "Relativity.OutsideIn" ], "name": "OutsideIn .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the OutsideIn .NET API reference for the Relativity.OutsideIn namespace.", "title": "OutsideIn .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_OutsideIn/OutsideInNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_OutsideIn/OutsideInNETAPI.html" }, "description": "OutsideIn .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "OutsideIn .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "OutsideIn .NET API Reference", "title": "OutsideIn .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot.htm" }, "description": "Find the Pivot business domain landing page for managing and executing Relativity Pivots, with links to the .NET and REST content and version history.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pivot", "Current Pivot API content", "Version History" ], "headings": [ "Pivot", "Current Pivot API content", "Version History" ], "name": "Pivot Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the Pivot business domain landing page for managing and executing Relativity Pivots, with links to the .NET and REST content and version history.", "title": "Pivot Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pivot Manager (.NET)", "Pivot fundamentals", "Create a PivotManager object", "Create a Pivot profile", "Update a Pivot profile", "Run a query based on a Pivot profile", "Execute a custom Pivot query", "Display query progress", "Cancel a query", "Work with query results", "Export a Pivot query" ], "headings": [ "Pivot Manager (.NET)", "Pivot fundamentals", "Create a PivotManager object", "Create a Pivot profile", "Update a Pivot profile", "Run a query based on a Pivot profile", "Execute a custom Pivot query", "Display query progress", "Cancel a query", "Work with query results", "Export a Pivot query" ], "name": "Pivot Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Pivot Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pivot Manager (REST)", "Pivot fundamentals", "Fields", "HTTP headers and status codes", "Create a Pivot profile", "Read a Pivot profile", "Update a Pivot profile", "Execute a custom Pivot query", "Export a Pivot query", "Sample JSON response", "Helper operations", "getGroupByFieldsForDocuments", "getPivotOnFieldsForDocuments" ], "headings": [ "Pivot Manager (REST)", "Pivot fundamentals", "Fields", "HTTP headers and status codes", "Create a Pivot profile", "Read a Pivot profile", "Update a Pivot profile", "Execute a custom Pivot query", "Export a Pivot query", "Sample JSON response", "Helper operations", "getGroupByFieldsForDocuments", "getPivotOnFieldsForDocuments" ], "name": "Pivot Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Pivot Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/Pivot_REST_API_Reference.htm" }, "description": "Browse the Pivot REST API reference for the relativity-pivot service and its endpoints.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pivot REST API Reference", "relativity-pivot" ], "headings": [ "Pivot REST API Reference", "relativity-pivot" ], "name": "Pivot REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Pivot REST API reference for the relativity-pivot service and its endpoints.", "title": "Pivot REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/PivotRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Pivot/PivotRESTAPI.html" }, "description": "Pivot REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Pivot REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Pivot REST API Reference", "title": "Pivot REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Field_Mapping_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Field_Mapping_API.htm" }, "description": "Use the Field Mapping Manager .NET service to retrieve mappable fields and read or update field mappings between Relativity and Invariant for processing.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Field Mapping Manager (.NET)", "Field mapping fundamentals", "Common field mapping workflow", "Code samples for the Field Mapping service", "Check field mapping availability", "Retrieve mapped Relativity fields", "Retrieve the contents of the Catalog Field table", "Retrieve Invariant fields available for mapping", "Retrieve Invariant fields available for mapping (paginated)", "Retrieve metadata fields", "Retrieve non-metadata fields", "Retrieve field given source name", "Retrieve an external field mapping", "Update an external field mapping", "Retrieve GUIDs for automapped fields" ], "headings": [ "Field Mapping Manager (.NET)", "Field mapping fundamentals", "Common field mapping workflow", "Code samples for the Field Mapping service", "Check field mapping availability", "Retrieve mapped Relativity fields", "Retrieve the contents of the Catalog Field table", "Retrieve Invariant fields available for mapping", "Retrieve Invariant fields available for mapping (paginated)", "Retrieve metadata fields", "Retrieve non-metadata fields", "Retrieve field given source name", "Retrieve an external field mapping", "Update an external field mapping", "Retrieve GUIDs for automapped fields" ], "name": "Field Mapping Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Field Mapping Manager .NET service to retrieve mappable fields and read or update field mappings between Relativity and Invariant for processing.", "title": "Field Mapping Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Field_Mapping_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Field_Mapping_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Field Mapping Manager (REST)", "Client code sample", "Check field mapping availability", "Retrieve mapped Relativity fields", "Retrieve Invariant fields available for mapping", "Retrieve an external field mapping", "Update an external field mapping", "Retrieve GUIDs for automapped fields", "Get Invariant fields available for mapping with pagination", "Retrieve metadata fields", "Retrieve non-metadata fields", "Retrieve field given source name", "Retrieve the contents of the Catalog Field table" ], "headings": [ "Field Mapping Manager (REST)", "Client code sample", "Check field mapping availability", "Retrieve mapped Relativity fields", "Retrieve Invariant fields available for mapping", "Retrieve an external field mapping", "Update an external field mapping", "Retrieve GUIDs for automapped fields", "Get Invariant fields available for mapping with pagination", "Retrieve metadata fields", "Retrieve non-metadata fields", "Retrieve field given source name", "Retrieve the contents of the Catalog Field table" ], "name": "Field Mapping Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Field Mapping Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Get_started_with_the_Processing_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Get_started_with_the_Processing_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Get started with the Processing API", "Processing API fundamentals", "Common processing workflows", "Processing API prerequisites", "Development guidelines for the Processing API" ], "headings": [ "Get started with the Processing API", "Processing API fundamentals", "Common processing workflows", "Processing API prerequisites", "Development guidelines for the Processing API" ], "name": "Get started with the Processing API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Get started with the Processing API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing", "Current Processing API content", "Previous versions of content", "Version History" ], "headings": [ "Processing", "Current Processing API content", "Previous versions of content", "Version History" ], "name": "Processing API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Processing API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_API_Reference.htm" }, "description": "Find the Processing API reference page, which has moved to the Processing landing page.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Processing API Reference", "headings": "Processing API Reference", "name": "Processing API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the Processing API reference page, which has moved to the Processing landing page.", "title": "Processing API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_API_services_for_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_API_services_for_REST.htm" }, "description": "Use the Processing REST services to automate processing workflows, including the custodian, data source, document, filter, job, set, and field mapping managers.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Processing API services for REST", "headings": "Processing API services for REST", "name": "Processing API services for REST", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Processing REST services to automate processing workflows, including the custodian, data source, document, filter, job, set, and field mapping managers.", "title": "Processing API services for REST" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Custodian_Manager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Custodian_Manager.htm" }, "description": "Use the IProcessingCustodianManager .NET interface to create, read, and update processing custodians, with code samples.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Custodian Manager (.NET)", "Create a processing custodian", "Read a processing custodian", "Update a processing custodian" ], "headings": [ "Processing Custodian Manager (.NET)", "Create a processing custodian", "Read a processing custodian", "Update a processing custodian" ], "name": "Processing Custodian Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the IProcessingCustodianManager .NET interface to create, read, and update processing custodians, with code samples.", "title": "Processing Custodian Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Custodian_Manager_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Custodian_Manager_REST.htm" }, "description": "Use the Processing Custodian Manager REST endpoint to create, read, and update custodians, with request body examples for individual and other entity types.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Custodian Manager (REST)", "Create a processing custodian", "Read a processing custodian", "Update a processing custodian" ], "headings": [ "Processing Custodian Manager (REST)", "Create a processing custodian", "Read a processing custodian", "Update a processing custodian" ], "name": "Processing Custodian Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Processing Custodian Manager REST endpoint to create, read, and update custodians, with request body examples for individual and other entity types.", "title": "Processing Custodian Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Data_Source_Manager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Data_Source_Manager.htm" }, "description": "Use the IProcessingDataSourceManager .NET interface to create, read, and update processing data sources, with parameters and code samples.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Data Source Manager (.NET)", "Create a processing data source", "Read a processing data source", "Update a processing data source", "Validate a processing data source for deletion", "Retrieve processing source location paths" ], "headings": [ "Processing Data Source Manager (.NET)", "Create a processing data source", "Read a processing data source", "Update a processing data source", "Validate a processing data source for deletion", "Retrieve processing source location paths" ], "name": "Processing Data Source Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the IProcessingDataSourceManager .NET interface to create, read, and update processing data sources, with parameters and code samples.", "title": "Processing Data Source Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Data_Source_Manager_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Data_Source_Manager_REST.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Data Source Manager (REST)", "Create a processing data source", "Read a processing data source", "Update a processing data source", "Validate a processing data source for deletion", "Retrieve processing source location paths" ], "headings": [ "Processing Data Source Manager (REST)", "Create a processing data source", "Read a processing data source", "Update a processing data source", "Validate a processing data source for deletion", "Retrieve processing source location paths" ], "name": "Processing Data Source Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Processing Data Source Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Document_Manager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Document_Manager.htm" }, "description": "Use the IProcessingDocumentManager .NET interface (v2) to retrieve document metadata and error history for documents in a publishing set, with code samples.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Document Manager (.NET) v2", "Retrieve metadata fields and values for a document", "Retrieve error history for a document", "Retry deleting documents", "Retry document errors", "Publish documents", "Retrieve publish job errors", "Retrieve count of publishable documents" ], "headings": [ "Processing Document Manager (.NET) v2", "Retrieve metadata fields and values for a document", "Retrieve error history for a document", "Retry deleting documents", "Retry document errors", "Publish documents", "Retrieve publish job errors", "Retrieve count of publishable documents" ], "name": "Processing Document Manager (.NET) v2", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the IProcessingDocumentManager .NET interface (v2) to retrieve document metadata and error history for documents in a publishing set, with code samples.", "title": "Processing Document Manager (.NET) v2" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Document_Manager_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Document_Manager_REST.htm" }, "description": "Use the Processing Document Manager REST endpoints (v2) to retrieve document metadata, file paths, and error history for documents in a publishing set.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Document Manager (REST) v2", "Retrieve metadata fields and values for a document", "Retrieve metadata fields and values for multiple documents", "Retrieve the physical file locations for the requested documents", "Retrieve error history for a document", "Retry deleting documents", "Retry document errors", "Publish documents", "Retrieve publish job errors", "Retrieve count of publishable documents" ], "headings": [ "Processing Document Manager (REST) v2", "Retrieve metadata fields and values for a document", "Retrieve metadata fields and values for multiple documents", "Retrieve the physical file locations for the requested documents", "Retrieve error history for a document", "Retry deleting documents", "Retry document errors", "Publish documents", "Retrieve publish job errors", "Retrieve count of publishable documents" ], "name": "Processing Document Manager (REST) v2", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Processing Document Manager REST endpoints (v2) to retrieve document metadata, file paths, and error history for documents in a publishing set.", "title": "Processing Document Manager (REST) v2" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Filter_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Filter_Manager_API.htm" }, "description": "Use the Processing Filter Manager .NET API (v2) to create, update, delete, and apply filters that select processed documents before publishing.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Filter Manager (.NET) v2", "Fundamentals for the Processing Filter Manager API", "Methods", "Classes and enumerations", "Guidelines for the Processing Filter Manager API", "Access rights", "Helper methods", "Filter expressions", "Apply a processing filter", "Retrieve discovered documents", "Retrieve discovered document IDs", "Pivot on discovered documents", "Download a csv listing of discovered files" ], "headings": [ "Processing Filter Manager (.NET) v2", "Fundamentals for the Processing Filter Manager API", "Methods", "Classes and enumerations", "Guidelines for the Processing Filter Manager API", "Access rights", "Helper methods", "Filter expressions", "Apply a processing filter", "Retrieve discovered documents", "Retrieve discovered document IDs", "Pivot on discovered documents", "Download a csv listing of discovered files" ], "name": "Processing Filter Manager (.NET) v2", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Processing Filter Manager .NET API (v2) to create, update, delete, and apply filters that select processed documents before publishing.", "title": "Processing Filter Manager (.NET) v2" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Filter_Manager_service_in_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Filter_Manager_service_in_REST.htm" }, "description": "Use the Processing Filter Manager REST service (v2) to create, update, delete, and apply filters that select processed documents before publishing.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Filter Manager (REST) v2", "Client code sample", "Guidelines for the Processing Filter Manager service", "Access rights", "Filter expressions", "Apply a processing filter", "Retrieve discovered documents", "Retrieve filtered data", "Pivot on discovered documents", "Get discovered documents IDs", "Download discovered documents list", "Download NISTed documents list for a processing set" ], "headings": [ "Processing Filter Manager (REST) v2", "Client code sample", "Guidelines for the Processing Filter Manager service", "Access rights", "Filter expressions", "Apply a processing filter", "Retrieve discovered documents", "Retrieve filtered data", "Pivot on discovered documents", "Get discovered documents IDs", "Download discovered documents list", "Download NISTed documents list for a processing set" ], "name": "Processing Filter Manager (REST) v2", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Processing Filter Manager REST service (v2) to create, update, delete, and apply filters that select processed documents before publishing.", "title": "Processing Filter Manager (REST) v2" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Job_Manager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Job_Manager.htm" }, "description": "Use the IProcessingJobManager .NET interface to submit inventory, discovery, and publishing jobs and cancel them for a processing set, with code samples.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Job Manager (.NET)", "Inventory jobs", "Discovery jobs", "Publishing jobs", "Retry Publishing jobs", "Cancel jobs" ], "headings": [ "Processing Job Manager (.NET)", "Inventory jobs", "Discovery jobs", "Publishing jobs", "Retry Publishing jobs", "Cancel jobs" ], "name": "Processing Job Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the IProcessingJobManager .NET interface to submit inventory, discovery, and publishing jobs and cancel them for a processing set, with code samples.", "title": "Processing Job Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Job_Manager_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Job_Manager_REST.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Job Manager (REST)", "Client code sample", "Submit a discovery job", "Submit a inventory job", "Submit a publish job", "Retry errors job", "Cancel job" ], "headings": [ "Processing Job Manager (REST)", "Client code sample", "Submit a discovery job", "Submit a inventory job", "Submit a publish job", "Retry errors job", "Cancel job" ], "name": "Processing Job Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Processing Job Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_NET_API_Reference.htm" }, "description": "Browse the Processing .NET API reference for the Relativity.Processing.SDK, including its interfaces and classes.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing .NET API Reference", "Relativity.Processing.SDK" ], "headings": [ "Processing .NET API Reference", "Relativity.Processing.SDK" ], "name": "Processing .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Processing .NET API reference for the Relativity.Processing.SDK, including its interfaces and classes.", "title": "Processing .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_REST_API_Reference.htm" }, "description": "Browse the Processing REST API reference (v1) for the relativity-processing service and its endpoints.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing REST API Reference (v1)", "relativity-processing" ], "headings": [ "Processing REST API Reference (v1)", "relativity-processing" ], "name": "Processing REST API Reference (v1)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Processing REST API reference (v1) for the relativity-processing service and its endpoints.", "title": "Processing REST API Reference (v1)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_REST_API_V2_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_REST_API_V2_Reference.htm" }, "description": "Browse the Processing REST API reference (v2) for the relativity-processing service and its endpoints.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing REST API Reference (v2)", "relativity-processing" ], "headings": [ "Processing REST API Reference (v2)", "relativity-processing" ], "name": "Processing REST API Reference (v2)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Processing REST API reference (v2) for the relativity-processing service and its endpoints.", "title": "Processing REST API Reference (v2)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Set_Manager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Set_Manager.htm" }, "description": "Use the IProcessingSetManager .NET interface to create, read, and update processing sets that link a processing profile to data sources, with code samples.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Set Manager (.NET)", "Create a processing set", "Read a processing set", "Update a processing set", "Retrieve a list of processing sets and related aggregate information", "Retrieve processing set summary data" ], "headings": [ "Processing Set Manager (.NET)", "Create a processing set", "Read a processing set", "Update a processing set", "Retrieve a list of processing sets and related aggregate information", "Retrieve processing set summary data" ], "name": "Processing Set Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the IProcessingSetManager .NET interface to create, read, and update processing sets that link a processing profile to data sources, with code samples.", "title": "Processing Set Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Set_Manager_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Processing_Set_Manager_REST.htm" }, "description": "Use the Processing Set Manager REST endpoint to create, read, and update processing sets that link a profile to data sources, with request examples.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Set Manager (REST)", "Create a processing set", "Read a processing set", "Update a processing set", "Retrieve document aggregates", "Retrieve processing set summary data" ], "headings": [ "Processing Set Manager (REST)", "Create a processing set", "Read a processing set", "Update a processing set", "Retrieve document aggregates", "Retrieve processing set summary data" ], "name": "Processing Set Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Processing Set Manager REST endpoint to create, read, and update processing sets that link a profile to data sources, with request examples.", "title": "Processing Set Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/ProcessingNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/ProcessingNETAPI.html" }, "description": "Processing .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Processing .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Processing .NET API Reference", "title": "Processing .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/ProcessingRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/ProcessingRESTAPI.html" }, "description": "Processing REST API Reference (v1)", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Processing REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Processing REST API Reference (v1)", "title": "Processing REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/ProcessingRESTAPIv2.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/ProcessingRESTAPIv2.html" }, "description": "Processing REST API Reference (v2)", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Processing REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Processing REST API Reference (v2)", "title": "Processing REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Troubleshooting_Processing_API_errors.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/Troubleshooting_Processing_API_errors.htm" }, "description": "Troubleshoot errors returned by custom processing workflows, such as IProcessingJobManager call errors, by reviewing each error message, description, and resolution.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Troubleshooting Processing API errors", "IProcessingJobManager method call errors", "IProcessingSetManager method call errors", "IProcessingDataSourceManager method call errors" ], "headings": [ "Troubleshooting Processing API errors", "IProcessingJobManager method call errors", "IProcessingSetManager method call errors", "IProcessingDataSourceManager method call errors" ], "name": "Troubleshooting Processing API errors", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Troubleshoot errors returned by custom processing workflows, such as IProcessingJobManager call errors, by reviewing each error message, description, and resolution.", "title": "Troubleshooting Processing API errors" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Document_Manager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Document_Manager.htm" }, "description": "Use the IProcessingDocumentManager .NET interface (v1) to retrieve document metadata and error history for documents in a publishing set, with code samples.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Document Manager (.NET) v1", "Retrieve metadata fields and values for a document", "Retrieve error history for a document", "Retry deleting documents", "Retry document errors", "Publish documents", "Retrieve publish job errors", "Retrieve count of publishable documents" ], "headings": [ "Processing Document Manager (.NET) v1", "Retrieve metadata fields and values for a document", "Retrieve error history for a document", "Retry deleting documents", "Retry document errors", "Publish documents", "Retrieve publish job errors", "Retrieve count of publishable documents" ], "name": "Processing Document Manager (.NET) v1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the IProcessingDocumentManager .NET interface (v1) to retrieve document metadata and error history for documents in a publishing set, with code samples.", "title": "Processing Document Manager (.NET) v1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Document_Manager_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Document_Manager_REST.htm" }, "description": "Use the Processing Document Manager REST endpoints (v1) to retrieve document metadata and error history and to retry document deletions and errors.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Document Manager (REST) v1", "Retrieve metadata fields and values for a document", "Retrieve error history for a document", "Retry deleting documents", "Retry document errors", "Publish documents", "Retrieve publish job errors", "Retrieve count of publishable documents" ], "headings": [ "Processing Document Manager (REST) v1", "Retrieve metadata fields and values for a document", "Retrieve error history for a document", "Retry deleting documents", "Retry document errors", "Publish documents", "Retrieve publish job errors", "Retrieve count of publishable documents" ], "name": "Processing Document Manager (REST) v1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Processing Document Manager REST endpoints (v1) to retrieve document metadata and error history and to retry document deletions and errors.", "title": "Processing Document Manager (REST) v1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Filter_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Filter_Manager_API.htm" }, "description": "Use the Processing Filter Manager .NET API (v1) to create, update, delete, and apply filters that select processed documents before publishing.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Filter Manager (.NET) v1", "Fundamentals for the Processing Filter Manager API", "Methods", "Classes and enumerations", "Guidelines for the Processing Filter Manager API", "Access rights", "Helper methods", "Filter expressions", "Create a processing filter", "Apply a processing filter", "Update a processing filter", "Delete a processing filter", "Retrieve discovered documents", "Retrieve discovered document IDs", "Retrieve the list of discovered files from invariant as a CSV", "Retrieve filtered data", "Retrieve processing filters", "Retrieve processing filters for a data source", "Pivot on discovered documents", "Download a csv listing of discovered files" ], "headings": [ "Processing Filter Manager (.NET) v1", "Fundamentals for the Processing Filter Manager API", "Methods", "Classes and enumerations", "Guidelines for the Processing Filter Manager API", "Access rights", "Helper methods", "Filter expressions", "Create a processing filter", "Apply a processing filter", "Update a processing filter", "Delete a processing filter", "Retrieve discovered documents", "Retrieve discovered document IDs", "Retrieve the list of discovered files from invariant as a CSV", "Retrieve filtered data", "Retrieve processing filters", "Retrieve processing filters for a data source", "Pivot on discovered documents", "Download a csv listing of discovered files" ], "name": "Processing Filter Manager (.NET) v1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Processing Filter Manager .NET API (v1) to create, update, delete, and apply filters that select processed documents before publishing.", "title": "Processing Filter Manager (.NET) v1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Filter_Manager_service_in_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_Filter_Manager_service_in_REST.htm" }, "description": "Use the Processing Filter Manager REST service (v1) to create, update, delete, and apply filters that select processed documents before publishing.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Processing Filter Manager (REST) v1", "Client code sample", "Guidelines for the Processing Filter Manager service", "Access rights", "Helper endpoints", "Filter expressions", "Create a processing filter", "Apply a processing filter", "Update a processing filter", "Delete a processing filter", "Retrieve discovered documents", "Retrieve filtered data", "Retrieve processing filters", "Retrieve processing filters for a data source", "Pivot on discovered documents", "Get discovered documents IDs", "Prepare discovered documents list", "Download discovered documents list" ], "headings": [ "Processing Filter Manager (REST) v1", "Client code sample", "Guidelines for the Processing Filter Manager service", "Access rights", "Helper endpoints", "Filter expressions", "Create a processing filter", "Apply a processing filter", "Update a processing filter", "Delete a processing filter", "Retrieve discovered documents", "Retrieve filtered data", "Retrieve processing filters", "Retrieve processing filters for a data source", "Pivot on discovered documents", "Get discovered documents IDs", "Prepare discovered documents list", "Download discovered documents list" ], "name": "Processing Filter Manager (REST) v1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Processing Filter Manager REST service (v1) to create, update, delete, and apply filters that select processed documents before publishing.", "title": "Processing Filter Manager (REST) v1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_v1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Processing/v1/Processing_v1.htm" }, "description": "Find the entry point to version 1 of the Processing API documentation, with a link to the current Processing content.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Processing v1", "headings": "Processing v1", "name": "Processing v1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the entry point to version 1 of the Processing API documentation, with a link to the current Processing content.", "title": "Processing v1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production", "Current Production API content", "Version History" ], "headings": [ "Production", "Current Production API content", "Version History" ], "name": "Production Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Production Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Data_Source_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Data_Source_Manager_API.htm" }, "description": "You can use the Services API\u0026#160;to create, delete, read, and update data sources that can then be added to productions.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production Data Source Manager (.NET)", "Fundamentals for the Production Data Source Manager API", "Create a data source", "Read a data source", "Update a data source", "Delete a data source", "Retrieve default field values for a data source" ], "headings": [ "Production Data Source Manager (.NET)", "Fundamentals for the Production Data Source Manager API", "Create a data source", "Read a data source", "Update a data source", "Delete a data source", "Retrieve default field values for a data source" ], "name": "Production Data Source Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "You can use the Services API\u0026#160;to create, delete, read, and update data sources that can then be added to productions.", "title": "Production Data Source Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Data_Source_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Data_Source_Manager_service.htm" }, "description": "The Relativity REST\u0026#160;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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production Data Source Manager (REST)", "Guidelines for productions in REST", "URLs", "Create a data source", "Retrieve a data source", "Update a data source", "Delete a data source", "Retrieve default field values for a data source" ], "headings": [ "Production Data Source Manager (REST)", "Guidelines for productions in REST", "URLs", "Create a data source", "Retrieve a data source", "Update a data source", "Delete a data source", "Retrieve default field values for a data source" ], "name": "Production Data Source Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The Relativity REST\u0026#160;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.", "title": "Production Data Source Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Manager_API.htm" }, "description": "The Productions API manages productions in a workspace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production Manager (.NET)", "Fundamentals for the Production Manager API", "Production sets and jobs", "Create a production set", "Retrieve a production set", "Delete a production set", "Stage a production", "Run a production job", "Stage and run multiple productions", "Re-run a production", "Run a Post Production Job", "Default fields and restrictions for productions", "Retrieve default field values for a production", "Set production restrictions on a workspace", "Retrieve the ID of a save search used for production restrictions", "Production job status, progress, and other information", "Retrieve the job status of a production", "Retrieve progress details for a production", "Retrieve production status details", "Retrieve results for produced image files", "Retrieve all productions in a workspace", "Retrieve produced productions for documents", "Retrieve a token for paging through images", "Production errors and document conflicts", "Retrieve conflicts, errors, and other production information", "Retrieve staging errors for a production", "Retrieve branding errors for a production", "Retrieve documents conflicting with production restrictions", "Remove documents conflicting with production restrictions", "Re-production jobs", "Retrieve productions eligible for re-production", "Retrieve re-productions for a specific production", "Stage and run a re-production job", "Cancel jobs for a re-production" ], "headings": [ "Production Manager (.NET)", "Fundamentals for the Production Manager API", "Production sets and jobs", "Create a production set", "Retrieve a production set", "Delete a production set", "Stage a production", "Run a production job", "Stage and run multiple productions", "Re-run a production", "Run a Post Production Job", "Default fields and restrictions for productions", "Retrieve default field values for a production", "Set production restrictions on a workspace", "Retrieve the ID of a save search used for production restrictions", "Production job status, progress, and other information", "Retrieve the job status of a production", "Retrieve progress details for a production", "Retrieve production status details", "Retrieve results for produced image files", "Retrieve all productions in a workspace", "Retrieve produced productions for documents", "Retrieve a token for paging through images", "Production errors and document conflicts", "Retrieve conflicts, errors, and other production information", "Retrieve staging errors for a production", "Retrieve branding errors for a production", "Retrieve documents conflicting with production restrictions", "Remove documents conflicting with production restrictions", "Re-production jobs", "Retrieve productions eligible for re-production", "Retrieve re-productions for a specific production", "Stage and run a re-production job", "Cancel jobs for a re-production" ], "name": "Production Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The Productions API manages productions in a workspace.", "title": "Production Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Manager_service.htm" }, "description": "Through the REST API, the Productions API manages productions in a workspace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production Manager (REST)", "Guidelines for productions in REST", "URLs", "Postman sample file", "Production sets and jobs", "Create a production set", "Retrieve a production set", "Delete a production set", "Stage a production", "Run a production job", "Stage and run multiple production jobs", "Re-run a production", "Run a Post Production Job", "Default fields and restrictions for productions", "Retrieve default field values for a production", "Set production restrictions on a workspace", "Retrieve the ID of a save search used for production restrictions", "Production job status, progress, and other information", "Retrieve the job status of a production", "Retrieve progress details for a production", "Retrieve production status details", "Retrieve results for produced image files", "Retrieve all productions in a workspace", "Retrieve produced productions for documents", "Retrieve a token for paging through images", "Production errors and document conflicts", "Retrieve conflicts, errors, and other production information", "Retrieve staging errors for a production", "Retrieve branding errors for a production", "Retrieve documents conflicting with production restrictions", "Remove documents conflicting with production restrictions", "Re-production jobs", "Retrieve productions eligible for re-production", "Retrieve re-productions for a specific production", "Stage and run a re-production job", "Cancel jobs for a re-production" ], "headings": [ "Production Manager (REST)", "Guidelines for productions in REST", "URLs", "Postman sample file", "Production sets and jobs", "Create a production set", "Retrieve a production set", "Delete a production set", "Stage a production", "Run a production job", "Stage and run multiple production jobs", "Re-run a production", "Run a Post Production Job", "Default fields and restrictions for productions", "Retrieve default field values for a production", "Set production restrictions on a workspace", "Retrieve the ID of a save search used for production restrictions", "Production job status, progress, and other information", "Retrieve the job status of a production", "Retrieve progress details for a production", "Retrieve production status details", "Retrieve results for produced image files", "Retrieve all productions in a workspace", "Retrieve produced productions for documents", "Retrieve a token for paging through images", "Production errors and document conflicts", "Retrieve conflicts, errors, and other production information", "Retrieve staging errors for a production", "Retrieve branding errors for a production", "Retrieve documents conflicting with production restrictions", "Remove documents conflicting with production restrictions", "Re-production jobs", "Retrieve productions eligible for re-production", "Retrieve re-productions for a specific production", "Stage and run a re-production job", "Cancel jobs for a re-production" ], "name": "Production Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Through the REST API, the Productions API manages productions in a workspace.", "title": "Production Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_NET_API_Reference.htm" }, "description": "Browse the Production .NET API reference for the Relativity.Productions.SDK, including its interfaces and classes.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production .NET API Reference", "Relativity.Productions.SDK" ], "headings": [ "Production .NET API Reference", "Relativity.Productions.SDK" ], "name": "Production .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Production .NET API reference for the Relativity.Productions.SDK, including its interfaces and classes.", "title": "Production .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Placeholder_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Placeholder_Manager_API.htm" }, "description": "You can use the Services API\u0026#160;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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production Placeholder Manager (.NET)", "Fundamentals for the Production Placeholder Manager API", "Create a placeholder", "Read a placeholder", "Update a placeholder", "Delete a placeholder", "Retrieve default field values for a placeholder" ], "headings": [ "Production Placeholder Manager (.NET)", "Fundamentals for the Production Placeholder Manager API", "Create a placeholder", "Read a placeholder", "Update a placeholder", "Delete a placeholder", "Retrieve default field values for a placeholder" ], "name": "Production Placeholder Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "You can use the Services API\u0026#160;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.", "title": "Production Placeholder Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Placeholder_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Placeholder_Manager_service.htm" }, "description": "Use the Production Placeholder Manager REST service to create, read, update, and delete placeholders and retrieve their default field values.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production Placeholder Manager (REST)", "Guidelines for productions in REST", "URLs", "Create a placeholder", "Retrieve a placeholder", "Update a placeholder", "Delete a placeholder", "Retrieve default field values for a placeholder" ], "headings": [ "Production Placeholder Manager (REST)", "Guidelines for productions in REST", "URLs", "Create a placeholder", "Retrieve a placeholder", "Update a placeholder", "Delete a placeholder", "Retrieve default field values for a placeholder" ], "name": "Production Placeholder Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Production Placeholder Manager REST service to create, read, update, and delete placeholders and retrieve their default field values.", "title": "Production Placeholder Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Queue_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Queue_Manager_API.htm" }, "description": "Use the Production Queue Manager .NET API to get production jobs in the queue, cancel or retry jobs, and set job priority.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production Queue Manager (.NET)", "Fundamentals for the Production Queue Manager API", "Get all production jobs in queue", "Cancel a production job", "Cancel production jobs by mass operation token", "Cancel production jobs by ID", "Set the priority on production jobs", "Retry production jobs\r\nby mass operation token", "Retry production jobs\r\nby ID" ], "headings": [ "Production Queue Manager (.NET)", "Fundamentals for the Production Queue Manager API", "Get all production jobs in queue", "Cancel a production job", "Cancel production jobs by mass operation token", "Cancel production jobs by ID", "Set the priority on production jobs", "Retry production jobs\r\nby mass operation token", "Retry production jobs\r\nby ID" ], "name": "Production Queue Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Production Queue Manager .NET API to get production jobs in the queue, cancel or retry jobs, and set job priority.", "title": "Production Queue Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Queue_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_Queue_Manager_service.htm" }, "description": "Use the Production Queue Manager REST service to get production jobs in the queue, cancel or retry jobs, and set job priority.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production Queue Manager (REST)", "Guidelines for productions in REST", "URLs", "Get all production jobs in queue", "Cancel a production job", "Cancel production jobs by mass operation token", "Cancel production jobs by ID", "Set the priority on production jobs", "Retry production jobs by mass operation token", "Retry production jobs by ID" ], "headings": [ "Production Queue Manager (REST)", "Guidelines for productions in REST", "URLs", "Get all production jobs in queue", "Cancel a production job", "Cancel production jobs by mass operation token", "Cancel production jobs by ID", "Set the priority on production jobs", "Retry production jobs by mass operation token", "Retry production jobs by ID" ], "name": "Production Queue Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Production Queue Manager REST service to get production jobs in the queue, cancel or retry jobs, and set job priority.", "title": "Production Queue Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Production_REST_API_Reference.htm" }, "description": "Browse the Production REST API reference for the relativity-productions service and its endpoints.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Production REST API Reference", "relativity-productions" ], "headings": [ "Production REST API Reference", "relativity-productions" ], "name": "Production REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Production REST API reference for the relativity-productions service and its endpoints.", "title": "Production REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/ProductionNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/ProductionNETAPI.html" }, "description": "Production .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Production .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Production .NET API Reference", "title": "Production .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/ProductionRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/ProductionRESTAPI.html" }, "description": "Production Service REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Productions REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Production Service REST Reference", "title": "Productions REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Reproduction_Job_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Reproduction_Job_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Re-production Job Manager (.NET)", "Fundamentals for the Re-production Manager API", "Create a re-production job", "Retrieve re-production job IDs", "Retrieve the status for a re-production job" ], "headings": [ "Re-production Job Manager (.NET)", "Fundamentals for the Re-production Manager API", "Create a re-production job", "Retrieve re-production job IDs", "Retrieve the status for a re-production job" ], "name": "Re-production Job Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Re-production Job Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Reproduction_Job_Manager_Service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Production/Reproduction_Job_Manager_Service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Re-production Job Manager (REST)", "Guidelines for productions in REST", "URLs", "Create a re-production job", "Use document IDs to create a job", "Use a mass operation token to create a job", "Retrieve re-production job IDs", "Retrieve the status for a re-production job" ], "headings": [ "Re-production Job Manager (REST)", "Guidelines for productions in REST", "URLs", "Create a re-production job", "Use document IDs to create a job", "Use a mass operation token to create a job", "Retrieve re-production job IDs", "Retrieve the status for a re-production job" ], "name": "Re-production Job Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Re-production Job Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/Other_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/Other_API_Reference.htm" }, "description": "Browse the Relativity Other .NET API reference for the Relativity.Other namespace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Other .NET API Reference", "Relativity.Other" ], "headings": [ "Relativity Other .NET API Reference", "Relativity.Other" ], "name": "Relativity Other .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Relativity Other .NET API reference for the Relativity.Other namespace.", "title": "Relativity Other .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/OtherNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/OtherNETAPI.html" }, "description": "Relativity Other .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity Other .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity Other .NET API Reference", "title": "Relativity Other .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/Server_Shared_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/Server_Shared_API_Reference.htm" }, "description": "Browse the Relativity Shared SDK .NET API reference for the Relativity.Shared.SDK namespace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Shared SDK .NET API Reference", "Relativity.Shared.SDK" ], "headings": [ "Relativity Shared SDK .NET API Reference", "Relativity.Shared.SDK" ], "name": "Relativity Shared SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Relativity Shared SDK .NET API reference for the Relativity.Shared.SDK namespace.", "title": "Relativity Shared SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/SharedNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_RelativityOne/SharedNETAPI.html" }, "description": "Relativity Shared SDK .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity Shared SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity Shared SDK .NET API Reference", "title": "Relativity Shared SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batch_Sets_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batch_Sets_Manager_API.htm" }, "description": "Use the Batch Sets Manager .NET API to create, read, update, and delete batch sets and to create and purge their batches.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Batch Sets Manager (.NET)", "Fundamentals for the Batch Sets Manager API", "Methods", "Classes and enumerations", "Create a batch set", "Read a batch set", "Update a batch set", "Delete a batch set", "Create batches in a batch set", "Remove batches from a batch set" ], "headings": [ "Batch Sets Manager (.NET)", "Fundamentals for the Batch Sets Manager API", "Methods", "Classes and enumerations", "Create a batch set", "Read a batch set", "Update a batch set", "Delete a batch set", "Create batches in a batch set", "Remove batches from a batch set" ], "name": "Batch Sets Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Batch Sets Manager .NET API to create, read, update, and delete batch sets and to create and purge their batches.", "title": "Batch Sets Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batch_Sets_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batch_Sets_Manager_service.htm" }, "description": "Use the Batch Sets Manager REST service to create, read, update, and delete batch sets and to create and purge their batches.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Batch Sets Manager (REST)", "Guidelines for the Batch Sets Manager service", "URLs", "Client code sample", "Create a batch set", "Request field descriptions", "Sample JSON request", "Response field descriptions", "Sample JSON response", "Read a batch set", "Sample JSON response", "Update a batch set", "Sample JSON request", "Delete a batch set", "Create batches", "Purge batches" ], "headings": [ "Batch Sets Manager (REST)", "Guidelines for the Batch Sets Manager service", "URLs", "Client code sample", "Create a batch set", "Request field descriptions", "Sample JSON request", "Response field descriptions", "Sample JSON response", "Read a batch set", "Sample JSON response", "Update a batch set", "Sample JSON request", "Delete a batch set", "Create batches", "Purge batches" ], "name": "Batch Sets Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Batch Sets Manager REST service to create, read, update, and delete batch sets and to create and purge their batches.", "title": "Batch Sets Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batches_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batches_Manager_API.htm" }, "description": "Use the Batches Manager .NET API to retrieve information about batches and to check batches in and out on behalf of reviewers.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Batches Manager (.NET)", "Fundamentals for the Batches Manager API", "Methods", "Classes and enumerations", "Read a batch", "Check out a batch", "Check in a batch" ], "headings": [ "Batches Manager (.NET)", "Fundamentals for the Batches Manager API", "Methods", "Classes and enumerations", "Read a batch", "Check out a batch", "Check in a batch" ], "name": "Batches Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Batches Manager .NET API to retrieve information about batches and to check batches in and out on behalf of reviewers.", "title": "Batches Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batches_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Batches_Manager_service.htm" }, "description": "Use the Batches Manager REST service to retrieve information about batches and to check batches in and out on behalf of reviewers.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Batches Manager (REST)", "Guidelines for the Batches Manager service", "URLs", "Client code sample", "Read a batch", "Check out a batch", "Check in a batch" ], "headings": [ "Batches Manager (REST)", "Guidelines for the Batches Manager service", "URLs", "Client code sample", "Read a batch", "Check out a batch", "Check in a batch" ], "name": "Batches Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Batches Manager REST service to retrieve information about batches and to check batches in and out on behalf of reviewers.", "title": "Batches Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Keyboard_Shortcuts_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Keyboard_Shortcuts_Manager_API.htm" }, "description": "Use the Keyboard Shortcuts Manager .NET API to retrieve the keyboard shortcuts in a workspace, such as those for the system, choices, or fields.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Keyboard Shortcuts Manager (.NET)", "Fundamentals for the Keyboard Shortcuts Manager API", "Methods", "Classes", "Retrieve keyboard shortcuts" ], "headings": [ "Keyboard Shortcuts Manager (.NET)", "Fundamentals for the Keyboard Shortcuts Manager API", "Methods", "Classes", "Retrieve keyboard shortcuts" ], "name": "Keyboard Shortcuts Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Keyboard Shortcuts Manager .NET API to retrieve the keyboard shortcuts in a workspace, such as those for the system, choices, or fields.", "title": "Keyboard Shortcuts Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Keyboard_Shortcuts_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Keyboard_Shortcuts_Manager_service.htm" }, "description": "Use the Keyboard Shortcuts Manager REST service to retrieve the keyboard shortcuts in a workspace, such as those for the system, choices, or fields.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Keyboard Shortcuts Manager (REST)", "Client code sample", "URLs", "Retrieve keyboard shortcut", "Response field descriptions", "Sample JSON response" ], "headings": [ "Keyboard Shortcuts Manager (REST)", "Client code sample", "URLs", "Retrieve keyboard shortcut", "Response field descriptions", "Sample JSON response" ], "name": "Keyboard Shortcuts Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Keyboard Shortcuts Manager REST service to retrieve the keyboard shortcuts in a workspace, such as those for the system, choices, or fields.", "title": "Keyboard Shortcuts Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Review.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Review.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Review", "Current Review API content", "Version History" ], "headings": [ "Review", "Current Review API content", "Version History" ], "name": "Review Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Review Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Review_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/Review_NET_API_Reference.htm" }, "description": "Browse the Review .NET API reference for the Relativity.Review.SDK, including its interfaces and classes.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Review .NET API Reference", "Relativity.Review.SDK" ], "headings": [ "Review .NET API Reference", "Relativity.Review.SDK" ], "name": "Review .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Review .NET API reference for the Relativity.Review.SDK, including its interfaces and classes.", "title": "Review .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/ReviewNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review/ReviewNETAPI.html" }, "description": "Review .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Review .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Review .NET API Reference", "title": "Review .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/Review_Center.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/Review_Center.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Review Center", "headings": "Review Center", "name": "Review Center", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Review Center" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/Review_Center_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/Review_Center_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Review Center (REST)", "Methods", "Base URL", "Authentication", "Bearer Token Authentication", "Permissions", "Finding workspace and queue IDs", "Errors", "Response codes", "Client code generation", "Code samples", "Calling the API with PowerShell", "Calling the API with C# and HttpClient" ], "headings": [ "Review Center (REST)", "Methods", "Base URL", "Authentication", "Bearer Token Authentication", "Permissions", "Finding workspace and queue IDs", "Errors", "Response codes", "Client code generation", "Code samples", "Calling the API with PowerShell", "Calling the API with C# and HttpClient" ], "name": "Review Center (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Review Center (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/Review_Center_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/Review_Center_API_Reference.htm" }, "description": "Browse the Review Center REST API reference for endpoint details, including queue statistics.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Review Center REST API Reference", "headings": "Review Center REST API Reference", "name": "Review Center REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Review Center REST API reference for endpoint details, including queue statistics.", "title": "Review Center REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/ReviewCenterRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Review_Center/ReviewCenterRESTAPI.html" }, "description": "Review Center API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Review Center REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Review Center API REST Reference", "title": "Review Center REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_RSMF/RSMF_Validator_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_RSMF/RSMF_Validator_NET_API_Reference.htm" }, "description": "Browse the RSMF Validator .NET API reference for the Relativity.RSMFU.Validator.SDK namespace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "RSMF Validator .NET API Reference", "Relativity.RSMFU.Validator.SDK" ], "headings": [ "RSMF Validator .NET API Reference", "Relativity.RSMFU.Validator.SDK" ], "name": "RSMF Validator .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the RSMF Validator .NET API reference for the Relativity.RSMFU.Validator.SDK namespace.", "title": "RSMF Validator .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_RSMF/RSMFValidatorNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_RSMF/RSMFValidatorNETAPI.html" }, "description": "RSMF Validator .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "RSMF Validator .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "RSMF Validator .NET API Reference", "title": "RSMF Validator .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Search Terms Report", "Current Search Terms Report API content", "Version History" ], "headings": [ "Search Terms Report", "Current Search Terms Report API content", "Version History" ], "name": "Search Terms Report Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Search Terms Report Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report_NET_API_Reference.htm" }, "description": "Browse the Search Terms Report .NET API reference for the Relativity.SearchTermsReport.SDK namespace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Search Terms Report .NET API Reference .NET API Reference", "Relativity.SearchTermsReport.SDK" ], "headings": [ "Search Terms Report .NET API Reference .NET API Reference", "Relativity.SearchTermsReport.SDK" ], "name": "Search Terms Report .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the Search Terms Report .NET API reference for the Relativity.SearchTermsReport.SDK namespace.", "title": "Search Terms Report .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report_Services_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report_Services_API.htm" }, "description": "Use the Search Terms Report Services .NET API to generate reports, add terms, retry errors, and view build progress for search terms reports.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Search Terms Report Services (.NET)", "Fundamentals for the Search Terms Report Services API", "Methods", "Classes and enumerations", "Create a Search Term Report", "Create terms for a search terms report", "Update terms for a search terms report", "Run all terms in a search terms report", "Run pending terms in a search terms report", "View the build progress of a search terms report", "Retry errors in a search terms report", "Cancel a running search terms report job", "Retrieve the URL for the Search Terms Result tab", "Retrieve the URL for a search terms report", "Check whether an index contains a long text field", "Retrieve the report type choice IDs" ], "headings": [ "Search Terms Report Services (.NET)", "Fundamentals for the Search Terms Report Services API", "Methods", "Classes and enumerations", "Create a Search Term Report", "Create terms for a search terms report", "Update terms for a search terms report", "Run all terms in a search terms report", "Run pending terms in a search terms report", "View the build progress of a search terms report", "Retry errors in a search terms report", "Cancel a running search terms report job", "Retrieve the URL for the Search Terms Result tab", "Retrieve the URL for a search terms report", "Check whether an index contains a long text field", "Retrieve the report type choice IDs" ], "name": "Search Terms Report Services (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Search Terms Report Services .NET API to generate reports, add terms, retry errors, and view build progress for search terms reports.", "title": "Search Terms Report Services (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report_Services_in_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/Search_Terms_Report_Services_in_REST.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Search Terms Report Services (REST)", "Guidelines for using the Search Terms Report Services", "URLs", "Create a Search Term Report", "Sample JSON request", "Create terms for a search terms report", "Request field descriptions", "Sample JSON request", "Sample JSON response", "Update terms for a search terms report", "Request field descriptions", "Sample JSON request", "Run all terms in a search terms report", "Run pending terms in a search terms report", "View the build progress of a search terms report", "Response field descriptions", "Sample JSON response", "Retry errors in a search terms report", "Cancel a running search terms report job", "Retrieve the URL for the Search Terms Result tab", "Retrieve the URL for a search terms report", "Check whether an index contains a long text field", "Retrieve object types for Search Terms Report and Result objects", "Response field descriptions", "Sample JSON response", "Retrieve the report type choice IDs", "Response field descriptions", "Sample JSON response" ], "headings": [ "Search Terms Report Services (REST)", "Guidelines for using the Search Terms Report Services", "URLs", "Create a Search Term Report", "Sample JSON request", "Create terms for a search terms report", "Request field descriptions", "Sample JSON request", "Sample JSON response", "Update terms for a search terms report", "Request field descriptions", "Sample JSON request", "Run all terms in a search terms report", "Run pending terms in a search terms report", "View the build progress of a search terms report", "Response field descriptions", "Sample JSON response", "Retry errors in a search terms report", "Cancel a running search terms report job", "Retrieve the URL for the Search Terms Result tab", "Retrieve the URL for a search terms report", "Check whether an index contains a long text field", "Retrieve object types for Search Terms Report and Result objects", "Response field descriptions", "Sample JSON response", "Retrieve the report type choice IDs", "Response field descriptions", "Sample JSON response" ], "name": "Search Terms Report Services (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Search Terms Report Services (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/SearchTermsReportNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Search_Terms_Report/SearchTermsReportNETAPI.html" }, "description": "Search Terms Report .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Search Terms Report .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Search Terms Report .NET API Reference", "title": "Search Terms Report .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Services/Relativity_Services_Interfaces.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Services/Relativity_Services_Interfaces.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity.Services.Interfaces", "Resources", "Version History" ], "headings": [ "Relativity.Services.Interfaces", "Resources", "Version History" ], "name": "Relativity.Services.Interfaces", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity.Services.Interfaces" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Services/Services_Data_Contracts_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Services/Services_Data_Contracts_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.Services.DataContracts.SDK assembly.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Services DataContracts SDK .NET API Reference", "Relativity.Services.DataContracts.SDK" ], "headings": [ "Relativity Services DataContracts SDK .NET API Reference", "Relativity.Services.DataContracts.SDK" ], "name": "Relativity Services DataContracts SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.Services.DataContracts.SDK assembly.", "title": "Relativity Services DataContracts SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Services/Services_Interfaces_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Services/Services_Interfaces_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.Services.Interfaces.SDK assembly.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity.Services.Interfaces .NET API Reference", "Relativity.Services.Interfaces.SDK" ], "headings": [ "Relativity.Services.Interfaces .NET API Reference", "Relativity.Services.Interfaces.SDK" ], "name": "Relativity.Services.Interfaces .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.Services.Interfaces.SDK assembly.", "title": "Relativity.Services.Interfaces .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Services/ServicesDataContractsNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Services/ServicesDataContractsNETAPI.html" }, "description": "Relativity Services DataContracts SDK .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity Services DataContracts SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity Services DataContracts SDK .NET API Reference", "title": "Relativity Services DataContracts SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Services/ServicesInterfacesNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Services/ServicesInterfacesNETAPI.html" }, "description": "Relativity.Services.Interfaces .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity.Services.Interfaces .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity.Services.Interfaces .NET API Reference", "title": "Relativity.Services.Interfaces .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Staging/Staging_Insights_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Staging/Staging_Insights_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Staging Reports APIs", "headings": "Staging Reports APIs", "name": "Staging Reports API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Staging Reports API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Staging/Staging_Insights_API__REST_.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Staging/Staging_Insights_API__REST_.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Staging Reports API (REST)", "Resources", "Permissions", "Considerations", "URLs", "Relativity aiR REST API authentication", "Bearer Token Authentication", "Rate limiting", "Postman sample file", "API endpoints/Operations", "Get containers", "List directories", "Generate new report", "Generate new summary report", "List reports", "Get report file", "Cancel report", "Get billable summary reports", "PowerShell code samples for staging reports", "Set variables", "Obtain access token", "Set headers and Uri for staging reports", "Retrieve containers", "List directories", "Generate a new report", "List all reports", "Get specific report file", "Cancel report", "Summary" ], "headings": [ "Staging Reports API (REST)", "Resources", "Permissions", "Considerations", "URLs", "Relativity aiR REST API authentication", "Bearer Token Authentication", "Rate limiting", "Postman sample file", "API endpoints/Operations", "Get containers", "List directories", "Generate new report", "Generate new summary report", "List reports", "Get report file", "Cancel report", "Get billable summary reports", "PowerShell code samples for staging reports", "Set variables", "Obtain access token", "Set headers and Uri for staging reports", "Retrieve containers", "List directories", "Generate a new report", "List all reports", "Get specific report file", "Cancel report", "Summary" ], "name": "Staging Reports API (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Staging Reports API (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Staging/Staging_Insights_REST_API_Reference_V4.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Staging/Staging_Insights_REST_API_Reference_V4.htm" }, "description": "View the REST API reference for version 4 of the Staging Reports API, the current version that replaces the deprecated v3 and earlier.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Staging Reports REST API Reference (V4)", "headings": "Staging Reports REST API Reference (V4)", "name": "Staging Reports REST API Reference (V4)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "View the REST API reference for version 4 of the Staging Reports API, the current version that replaces the deprecated v3 and earlier.", "title": "Staging Reports REST API Reference (V4)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Staging/StagingInsightsRESTAPIv4.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Staging/StagingInsightsRESTAPIv4.html" }, "description": "Staging Reports API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Staging Reports REST API (V4) Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Staging Reports API REST Reference", "title": "Staging Reports REST API (V4) Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Storage/Glacier.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Storage/Glacier.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Glacier Storage API", "Current Glacier API content" ], "headings": [ "Glacier Storage API", "Current Glacier API content" ], "name": "Glacier", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Glacier" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Storage/Glacier_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Storage/Glacier_REST.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Glacier Storage API (REST)", "Authentication", "Base URLs", "Creating Glacier Store", "Get Glacier Store Job Status", "Restoring from Glacier", "Get Glacier Restore Status", "List Glaciers", "Get Inventory Report Details", "Usage Examples", "Creating a Glacier Store Job", "Checking Glacier Store Status", "Restoring from Glacier", "Checking Restore Status", "Listing Glaciers", "Getting Glacier Inventory Report Details", "Error Handling", "Rate Limits", "Monitoring and Observability", "Best Practices" ], "headings": [ "Glacier Storage API (REST)", "Authentication", "Base URLs", "Creating Glacier Store", "Get Glacier Store Job Status", "Restoring from Glacier", "Get Glacier Restore Status", "List Glaciers", "Get Inventory Report Details", "Usage Examples", "Creating a Glacier Store Job", "Checking Glacier Store Status", "Restoring from Glacier", "Checking Restore Status", "Listing Glaciers", "Getting Glacier Inventory Report Details", "Error Handling", "Rate Limits", "Monitoring and Observability", "Best Practices" ], "name": "Glacier REST API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Glacier REST API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Storage/Glacier_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Storage/Glacier_REST_API_Reference.htm" }, "description": "View the REST API reference for the Glacier API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Glacier REST API Reference", "Glacier REST API" ], "headings": [ "Glacier REST API Reference", "Glacier REST API" ], "name": "Glacier REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "View the REST API reference for the Glacier API.", "title": "Glacier REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Storage/GlacierRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Storage/GlacierRESTAPI.html" }, "description": "Staging Reports API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Glacier REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Staging Reports API REST Reference", "title": "Glacier REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Get_started_with_the_Structured_Analytics_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Get_started_with_the_Structured_Analytics_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Structured Analytics Job Manager (.NET)", "Fundamentals for the Structured Analytics Job Manager API", "Structured analytics overview", "API namespaces", "Guidelines for the Structured Analytics Job Manager API", "Custom code implementation", "Code samples", "Relativity environment setup", "Generate result fields before running an analysis", "Retrieve valid operations for a structured analytics set", "Run an analysis of a structured analytics set", "Cancel an analysis", "Check the status of an analysis", "Retry errors in an analysis", "Retrieve analysis errors for a structured analytics set", "Retrieve document errors for an analysis", "Work with legacy document fields", "Copy to legacy document fields", "Cancel copy to legacy fields" ], "headings": [ "Structured Analytics Job Manager (.NET)", "Fundamentals for the Structured Analytics Job Manager API", "Structured analytics overview", "API namespaces", "Guidelines for the Structured Analytics Job Manager API", "Custom code implementation", "Code samples", "Relativity environment setup", "Generate result fields before running an analysis", "Retrieve valid operations for a structured analytics set", "Run an analysis of a structured analytics set", "Cancel an analysis", "Check the status of an analysis", "Retry errors in an analysis", "Retrieve analysis errors for a structured analytics set", "Retrieve document errors for an analysis", "Work with legacy document fields", "Copy to legacy document fields", "Cancel copy to legacy fields" ], "name": "Structured Analytics Job Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Structured Analytics Job Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics.htm" }, "description": "Find the Structured Analytics business domain overview, including the changelog, links to the .NET and REST Job Manager content, and the version history.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Structured Analytics", "Current Structured Analytics API content", "Version History" ], "headings": [ "Structured Analytics", "Current Structured Analytics API content", "Version History" ], "name": "Structured Analytics Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the Structured Analytics business domain overview, including the changelog, links to the .NET and REST Job Manager content, and the version history.", "title": "Structured Analytics Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics_Manager_service_in_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics_Manager_service_in_REST.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Structured Analytics Job Manager (REST)", "Guidelines for the Structured Analytics Job Manager service", "URLs", "Custom code", "Postman sample file", "Client code sample", "Generate result fields before running an analysis", "Retrieve valid operations for a structured analytics set", "Run an analysis of a structured analytics set", "Cancel an analysis", "Check the status of an analysis", "Retry errors in an analysis", "Retrieve analysis errors for a structured analytics set", "Retrieve document errors for an analysis", "Work with legacy document fields", "Copy results to legacy document fields", "Cancel a job for copying content to legacy fields" ], "headings": [ "Structured Analytics Job Manager (REST)", "Guidelines for the Structured Analytics Job Manager service", "URLs", "Custom code", "Postman sample file", "Client code sample", "Generate result fields before running an analysis", "Retrieve valid operations for a structured analytics set", "Run an analysis of a structured analytics set", "Cancel an analysis", "Check the status of an analysis", "Retry errors in an analysis", "Retrieve analysis errors for a structured analytics set", "Retrieve document errors for an analysis", "Work with legacy document fields", "Copy results to legacy document fields", "Cancel a job for copying content to legacy fields" ], "name": "Structured Analytics Job Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Structured Analytics Job Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.StructuredAnalytics.SDK assembly.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Structured Analytics .NET API Reference", "Relativity.StructuredAnalytics.SDK" ], "headings": [ "Structured Analytics .NET API Reference", "Relativity.StructuredAnalytics.SDK" ], "name": "Structured Analytics .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.StructuredAnalytics.SDK assembly.", "title": "Structured Analytics .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/Structured_Analytics_REST_API_Reference.htm" }, "description": "View the REST API reference for the Structured Analytics Job Manager service.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Structured Analytics REST API Reference", "Structured Analytics REST API Reference" ], "headings": [ "Structured Analytics REST API Reference", "Structured Analytics REST API Reference" ], "name": "Structured Analytics REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "View the REST API reference for the Structured Analytics Job Manager service.", "title": "Structured Analytics REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/StructuredAnalyticsNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/StructuredAnalyticsNETAPI.html" }, "description": "[API NAME] .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "[API NAME] .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "[API NAME] .NET API Reference", "title": "[API NAME] .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/StructuredAnalyticsRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Structured_Analytics/StructuredAnalyticsRESTAPI.html" }, "description": "Structured Analytics Jobs REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Structured Analytics Jobs Manager REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Structured Analytics Jobs REST API Reference", "title": "Structured Analytics Jobs Manager REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/Telemetry_DataContracts_Shared_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/Telemetry_DataContracts_Shared_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.Telemetry.DataContracts.Shared assembly.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Telemetry DataContracts Shared .NET API Reference", "Relativity.Telemetry.DataContracts.Shared" ], "headings": [ "Telemetry DataContracts Shared .NET API Reference", "Relativity.Telemetry.DataContracts.Shared" ], "name": "Telemetry DataContracts Shared .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.Telemetry.DataContracts.Shared assembly.", "title": "Telemetry DataContracts Shared .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/Telemetry_Services_Interfaces_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/Telemetry_Services_Interfaces_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.Telemetry.Services.Interface assembly.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Telemetry Services Interfaces .NET API Reference", "Relativity.Telemetry.Services.Interface" ], "headings": [ "Telemetry Services Interfaces .NET API Reference", "Relativity.Telemetry.Services.Interface" ], "name": "Telemetry Services Interfaces .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.Telemetry.Services.Interface assembly.", "title": "Telemetry Services Interfaces .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryDataContractsSharedNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryDataContractsSharedNETAPI.html" }, "description": "Telemetry DataContracts Shared .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Telemetry DataContracts Shared .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Telemetry DataContracts Shared .NET API Reference", "title": "Telemetry DataContracts Shared .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryMetrics_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryMetrics_REST_API_Reference.htm" }, "description": "View the REST API reference for the Telemetry Metrics service.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Telemetry Metrics REST API Reference", "Telemetry Metrics REST API Reference" ], "headings": [ "Telemetry Metrics REST API Reference", "Telemetry Metrics REST API Reference" ], "name": "Telemetry Metrics REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "View the REST API reference for the Telemetry Metrics service.", "title": "Telemetry Metrics REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryMetricsRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryMetricsRESTAPI.html" }, "description": "Telemetry Metrics REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Telemetry Metrics REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Telemetry Metrics REST API Reference", "title": "Telemetry Metrics REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryServicesInterfacesNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Telemetry/TelemetryServicesInterfacesNETAPI.html" }, "description": "Telemetry Services Interfaces .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Telemetry Services Interfaces .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Telemetry Services Interfaces .NET API Reference", "title": "Telemetry Services Interfaces .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Text_Storage/Field_Size_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Text_Storage/Field_Size_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Field Size API", "Service URL", "Request headers", "Request body", "Response", "Error handling", "HTTP\u0026#160;return code", "Error message", "Error types" ], "headings": [ "Field Size API", "Service URL", "Request headers", "Request body", "Response", "Error handling", "HTTP\u0026#160;return code", "Error message", "Error types" ], "name": "Field Size API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Field Size API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Text_Storage/Text_Storage.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Text_Storage/Text_Storage.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Text Storage", "Text Storage changelog", "Current Text Storage API content" ], "headings": [ "Text Storage", "Text Storage changelog", "Current Text Storage API content" ], "name": "Text Storage Business Domain Landing Page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Text Storage Business Domain Landing Page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Transfer/Transfer_Client_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Transfer/Transfer_Client_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.Transfer.Client assembly.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Transfer Client .NET API Reference", "Relativity.Transfer.Client" ], "headings": [ "Transfer Client .NET API Reference", "Relativity.Transfer.Client" ], "name": "Transfer Client .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.Transfer.Client assembly.", "title": "Transfer Client .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Transfer/TransferClientNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Transfer/TransferClientNETAPI.html" }, "description": "Transfer Client .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Transfer Client .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Transfer Client .NET API Reference", "title": "Transfer Client .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/Usage.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/Usage.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Usage Report API", "headings": "Usage Report API", "name": "Usage", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Usage" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/Usage_Report_API_Reference_V1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/Usage_Report_API_Reference_V1.htm" }, "description": "View the REST API reference for version 1 of the Usage Report API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Usage Report REST API Reference (V1)", "headings": "Usage Report REST API Reference (V1)", "name": "Usage Report REST API Reference (V1)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "View the REST API reference for version 1 of the Usage Report API.", "title": "Usage Report REST API Reference (V1)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/Usage_Reports_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/Usage_Reports_API.htm" }, "description": "Get started with the Usage Reports API, including the required instance permissions, URL format with the version path parameter, authentication, and available endpoints.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Usage Reports API", "Guidelines for the Usage Reports API", "Permissions", "URLs", "Relativity aiR REST API Authentication", "Bearer Token Authentication", "Rate Limiting", "API Endpoints", "Get metadata", "List reports", "Generate new report", "Download report by ID", "Get report", "Get report details", "Delete Report", "PowerShell code samples for Usage Reports", "Bearer Access tokens in PowerShell", "Set headers and Uri for Usage Reports.", "Retrieve usage reports", "Linked repository metrics migration" ], "headings": [ "Usage Reports API", "Guidelines for the Usage Reports API", "Permissions", "URLs", "Relativity aiR REST API Authentication", "Bearer Token Authentication", "Rate Limiting", "API Endpoints", "Get metadata", "List reports", "Generate new report", "Download report by ID", "Get report", "Get report details", "Delete Report", "PowerShell code samples for Usage Reports", "Bearer Access tokens in PowerShell", "Set headers and Uri for Usage Reports.", "Retrieve usage reports", "Linked repository metrics migration" ], "name": "Usage Reports API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Get started with the Usage Reports API, including the required instance permissions, URL format with the version path parameter, authentication, and available endpoints.", "title": "Usage Reports API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/UsageReportRESTAPIv1.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Usage_Report/UsageReportRESTAPIv1.html" }, "description": "Usage Report API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Usage Report REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Usage Report API REST Reference", "title": "Usage Report REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/Workspace_Service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/Workspace_Service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Workspace Service API", "headings": "Workspace Service API", "name": "Workspace Service API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Workspace Service API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/Workspace_Service_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/Workspace_Service_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Workspace Service API", "Guidelines for the Workspace Service API", "URLs", "Relativity aiR REST API authentication", "Overview", "Cookie authentication", "Bearer Token Authentication", "Response codes", "API endpoints", "Get State" ], "headings": [ "Workspace Service API", "Guidelines for the Workspace Service API", "URLs", "Relativity aiR REST API authentication", "Overview", "Cookie authentication", "Bearer Token Authentication", "Response codes", "API endpoints", "Get State" ], "name": "Workspace Service API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Workspace Service API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/Workspace_Service_API_Reference_V1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/Workspace_Service_API_Reference_V1.htm" }, "description": "View the REST API reference for version 1 of the Workspace Service API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Workspace Service REST API Reference (V1)", "headings": "Workspace Service REST API Reference (V1)", "name": "Workspace Service REST API Reference (V1)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "View the REST API reference for version 1 of the Workspace Service API.", "title": "Workspace Service REST API Reference (V1)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/WorkspaceServiceRESTAPIv1.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/BD_Workspace_Service/WorkspaceServiceRESTAPIv1.html" }, "description": "Workspace Service API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Workspace Service REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Workspace Service API REST Reference", "title": "Workspace Service REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Advanced_functionality_for_the_application_framework.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Advanced_functionality_for_the_application_framework.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Advanced functionality for the application framework", "Hosted and schema component", "Schema version", "Application schema versions", "Upgrades and schema versions", "Tab behavior during installations and upgrades", "Object type event handler behavior during upgrades", "Application resource file purge" ], "headings": [ "Advanced functionality for the application framework", "Hosted and schema component", "Schema version", "Application schema versions", "Upgrades and schema versions", "Tab behavior during installations and upgrades", "Object type event handler behavior during upgrades", "Application resource file purge" ], "name": "Advanced functionality for the application framework", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Advanced functionality for the application framework" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Basic_concepts_for_the_application_framework.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Basic_concepts_for_the_application_framework.htm" }, "description": "Review these basic concepts to learn more about using the Application Deployment System (ADS) as your application framework.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Basic concepts for the application framework", "Package applications", "View component GUIDs" ], "headings": [ "Basic concepts for the application framework", "Package applications", "View component GUIDs" ], "name": "Basic concepts for the application framework", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Review these basic concepts to learn more about using the Application Deployment System (ADS) as your application framework.", "title": "Basic concepts for the application framework" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Best_practices_for_application_building.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Best_practices_for_application_building.htm" }, "description": "Use these guidelines when developing Relativity applications through the Application Deployment System (ADS).", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Best practices for building applications", "Set up a dedicated environment for application development", "Use GUIDs to reference object types", "Use GUIDs when developing event handlers", "Set the RunTarget attribute on event handlers", "Use Relativity API Helpers for establishing Services API connections", "Use the Relativity UI to edit applications", "Don\u0027t downgrade application versions", "Keep applications locked unless you\u0027re editing them", "Maintain application validation requirements", "Implement your own application components", "Add an About page", "Open and close connections", "Batch data", "Test various file types", "Do not include assemblies in RAP files for assemblies provided by Relativity" ], "headings": [ "Best practices for building applications", "Set up a dedicated environment for application development", "Use GUIDs to reference object types", "Use GUIDs when developing event handlers", "Set the RunTarget attribute on event handlers", "Use Relativity API Helpers for establishing Services API connections", "Use the Relativity UI to edit applications", "Don\u0027t downgrade application versions", "Keep applications locked unless you\u0027re editing them", "Maintain application validation requirements", "Implement your own application components", "Add an About page", "Open and close connections", "Batch data", "Test various file types", "Do not include assemblies in RAP files for assemblies provided by Relativity" ], "name": "Best practices for building applications", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use these guidelines when developing Relativity applications through the Application Deployment System (ADS).", "title": "Best practices for building applications" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Building_Relativity_applications.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Building_Relativity_applications.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Build applications", "Use the ADS", "Writing custom code for applications" ], "headings": [ "Build applications", "Use the ADS", "Writing custom code for applications" ], "name": "Build applications", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Build applications" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Building_your_first_application.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Building_your_first_application.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Build your first Relativity application in the UI", "Before you begin", "Build a Relativity application in the UI" ], "headings": [ "Build your first Relativity application in the UI", "Before you begin", "Build a Relativity application in the UI" ], "name": "Build your first Relativity application in the UI", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Build your first Relativity application in the UI" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Creating_an_application_in_Relativity.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Creating_an_application_in_Relativity.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Create an application in Relativity", "Create an application", "New application layout fields", "View or edit application details", "Add components to an application", "Associative lists", "Validation requirements for application components" ], "headings": [ "Create an application in Relativity", "Create an application", "New application layout fields", "View or edit application details", "Add components to an application", "Associative lists", "Validation requirements for application components" ], "name": "Create an application in Relativity", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Create an application in Relativity" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Developing_application_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Developing_application_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Develop application event handlers", "headings": "Develop application event handlers", "name": "Develop application event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Develop application event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Loading_application_resources.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Loading_application_resources.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Loading application resources", "Application domain directories", "Agents", "Custom pages", "Event handlers", "Loading order and priority" ], "headings": [ "Loading application resources", "Application domain directories", "Agents", "Custom pages", "Event handlers", "Loading order and priority" ], "name": "Loading application resources", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Loading application resources" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Post_Install_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Post_Install_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Post Install event handlers", "Guidelines for Post Install event handlers", "Code sample for a Post Install event handler" ], "headings": [ "Post Install event handlers", "Guidelines for Post Install event handlers", "Code sample for a Post Install event handler" ], "name": "Post Install event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Post Install event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Post_Workspace_Create_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Post_Workspace_Create_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Post Workspace Create event handlers", "Guidelines for Post Workspace Create event handlers", "Code sample for a Post Workspace Create event handler" ], "headings": [ "Post Workspace Create event handlers", "Guidelines for Post Workspace Create event handlers", "Code sample for a Post Workspace Create event handler" ], "name": "Post Workspace Create event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Post Workspace Create event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_and_Post_Install_event_handlers_overview.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_and_Post_Install_event_handlers_overview.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pre and Post Install event handlers", "Run Pre and Post Install event handlers", "Log messages for Pre and Post Install event handlers" ], "headings": [ "Pre and Post Install event handlers", "Run Pre and Post Install event handlers", "Log messages for Pre and Post Install event handlers" ], "name": "Pre and Post Install event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Pre and Post Install event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_Install_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_Install_event_handlers.htm" }, "description": "Develop Pre Install event handlers that run custom code during application installation, such as creating database tables. Includes guidelines and a sample DependencyCheckPreInstallEventHandler class.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pre Install event handlers", "Guidelines for Pre Install event handlers", "Code sample for a Pre Install event handler" ], "headings": [ "Pre Install event handlers", "Guidelines for Pre Install event handlers", "Code sample for a Pre Install event handler" ], "name": "Pre Install event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Develop Pre Install event handlers that run custom code during application installation, such as creating database tables. Includes guidelines and a sample DependencyCheckPreInstallEventHandler class.", "title": "Pre Install event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_Uninstall_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_Uninstall_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pre Uninstall event handlers", "Guidelines for Pre Uninstall event handlers", "Code sample for a Pre Uninstall event handler" ], "headings": [ "Pre Uninstall event handlers", "Guidelines for Pre Uninstall event handlers", "Code sample for a Pre Uninstall event handler" ], "name": "Pre Uninstall event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Pre Uninstall event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_Workspace_Delete_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Pre_Workspace_Delete_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pre Workspace Delete event handlers", "Guidelines for Pre Workspace Delete event handlers", "Code sample for a Pre Workspace Delete event handler" ], "headings": [ "Pre Workspace Delete event handlers", "Guidelines for Pre Workspace Delete event handlers", "Code sample for a Pre Workspace Delete event handler" ], "name": "Pre Workspace Delete event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Pre Workspace Delete event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Relativity_applications.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Relativity_applications.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Application Framework", "Use cases for extending Relativity", "Sample workflow for building applications" ], "headings": [ "Relativity Application Framework", "Use cases for extending Relativity", "Sample workflow for building applications" ], "name": "Relativity Application Framework", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity Application Framework" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Troubleshooting_applications_errors.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Building_Relativity_applications/Troubleshooting_applications_errors.htm" }, "description": "You can use the information to view application errors and to resolve specific types of errors.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Troubleshoot application errors", "View application errors", "Stack traces for install event handler failures", "Rerun RunOnce install event handlers", "Can\u0027t export due to unassigned event handlers or agents", "Can’t find assembly for event handler on an object type" ], "headings": [ "Troubleshoot application errors", "View application errors", "Stack traces for install event handler failures", "Rerun RunOnce install event handlers", "Can\u0027t export due to unassigned event handlers or agents", "Can’t find assembly for event handler on an object type" ], "name": "Troubleshoot application errors", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "You can use the information to view application errors and to resolve specific types of errors.", "title": "Troubleshoot application errors" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Cold_Storage/Cold_Storage.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Cold_Storage/Cold_Storage.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Cold Storage", "Current Cold Storage API content", "Version History" ], "headings": [ "Cold Storage", "Current Cold Storage API content", "Version History" ], "name": "Cold Storage", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Cold Storage" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Cold_Storage/Cold_Storage_Manager_Net.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Cold_Storage/Cold_Storage_Manager_Net.htm" }, "description": "Use the Cold Storage Manager .NET API to move workspaces into or out of cold storage and to check a workspace\u0027s cold storage status. Lists the IColdStorageManager methods.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Cold Storage Manager (.NET)", "Fundamentals for the Cold Storage Manager API", "Methods", "Classes and enumerations", "Guidelines for the Cold Storage Manager API", "Move Workspace Into Cold Storage", "Move Workspace Out Of Cold Storage", "Get Workspace Cold Storage Status" ], "headings": [ "Cold Storage Manager (.NET)", "Fundamentals for the Cold Storage Manager API", "Methods", "Classes and enumerations", "Guidelines for the Cold Storage Manager API", "Move Workspace Into Cold Storage", "Move Workspace Out Of Cold Storage", "Get Workspace Cold Storage Status" ], "name": "Cold Storage Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Cold Storage Manager .NET API to move workspaces into or out of cold storage and to check a workspace\u0027s cold storage status. Lists the IColdStorageManager methods.", "title": "Cold Storage Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Cold_Storage/Cold_Storage_Manager_REST.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Cold_Storage/Cold_Storage_Manager_REST.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Cold Storage Manager (REST)", "Postman sample file", "Client code sample", "Move Workspace Into Cold Storage", "Move Workspace Out Of Cold Storage", "Get Workspace Cold Storage Status" ], "headings": [ "Cold Storage Manager (REST)", "Postman sample file", "Client code sample", "Move Workspace Into Cold Storage", "Move Workspace Out Of Cold Storage", "Get Workspace Cold Storage Status" ], "name": "Cold Storage Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Cold Storage Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/CoveoSearch.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/CoveoSearch.htm" }, "description": "Search Relativity documentation, knowledgebase articles, events, news, and files.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Search Results", "headings": "Search Results", "name": "Search Relativity Documentation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Search Relativity documentation, knowledgebase articles, events, news, and files.", "title": "Search Relativity Documentation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Advanced_functionality_for_custom_pages.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Advanced_functionality_for_custom_pages.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Advanced functionality for custom pages", "Custom authentication", "Manually enable Forms or Windows Authentication in IIS", "Enable Forms or Windows Authentication via your custom page\u0027s web.config" ], "headings": [ "Advanced functionality for custom pages", "Custom authentication", "Manually enable Forms or Windows Authentication in IIS", "Enable Forms or Windows Authentication via your custom page\u0027s web.config" ], "name": "Advanced functionality for custom pages", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Advanced functionality for custom pages" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Basic_concepts_for_custom_pages.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Basic_concepts_for_custom_pages.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Basic concepts for custom pages", "Connect to the Services API with the client-side proxy", "Obtain user and other context information with API Helpers", "Custom page deployment", "Supported file types for custom pages", "Use URLs as links to custom pages", "Obtain the application GUID", "Deploy the custom page", "Use external tabs as links to custom pages", "Create tabs available in a workspace", "Create tabs available from Home", "Simplify custom page URLs", "Readiness check URL", "Use console event handlers to access custom pages" ], "headings": [ "Basic concepts for custom pages", "Connect to the Services API with the client-side proxy", "Obtain user and other context information with API Helpers", "Custom page deployment", "Supported file types for custom pages", "Use URLs as links to custom pages", "Obtain the application GUID", "Deploy the custom page", "Use external tabs as links to custom pages", "Create tabs available in a workspace", "Create tabs available from Home", "Simplify custom page URLs", "Readiness check URL", "Use console event handlers to access custom pages" ], "name": "Basic concepts for custom pages", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Basic concepts for custom pages" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Best_practices_for_custom_pages.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Best_practices_for_custom_pages.htm" }, "description": "Use these guidelines to optimize your application development with custom pages.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Best practices for custom pages", "Use helper classes", "Secure custom pages as necessary", "Authorize users for operations", "Avoid using underscores to begin file names", "Don\u0027t use restricted file types for custom pages" ], "headings": [ "Best practices for custom pages", "Use helper classes", "Secure custom pages as necessary", "Authorize users for operations", "Avoid using underscores to begin file names", "Don\u0027t use restricted file types for custom pages" ], "name": "Best practices for custom pages", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use these guidelines to optimize your application development with custom pages.", "title": "Best practices for custom pages" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Building_your_first_custom_page.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Building_your_first_custom_page.htm" }, "description": "This tutorial illustrates how to create a custom page using Visual Studio templates.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Build your first custom page", "Before you begin", "Build a custom page", "Deploy a custom page" ], "headings": [ "Build your first custom page", "Before you begin", "Build a custom page", "Deploy a custom page" ], "name": "Build a custom page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This tutorial illustrates how to create a custom page using Visual Studio templates.", "title": "Build a custom page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Configuration_Values.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Configuration_Values.htm" }, "description": "Retrieve Relativity configuration values, such as application paths, version, currency symbol, and instance GUID, using the property getters and function getters on window.relativity.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Configuration Values", "Property Getters", "Function Getters", "Deprecated Functions and Properties, and replacements", "Deprecated Functions", "Deprecated Properties" ], "headings": [ "Configuration Values", "Property Getters", "Function Getters", "Deprecated Functions and Properties, and replacements", "Deprecated Functions", "Deprecated Properties" ], "name": "Configuration Values", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Retrieve Relativity configuration values, such as application paths, version, currency symbol, and instance GUID, using the property getters and function getters on window.relativity.", "title": "Configuration Values" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Custom_Pages_migration.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Custom_Pages_migration.htm" }, "description": "Migration of custom pages in Relativity aiR to the modernized compute platform", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Custom Pages migration checklist", "Determining if your Custom Page is affected", "JavaScript API changes", "Relativity-hosted assets changes", "Server-side requirements", "Frequently Asked Questions" ], "headings": [ "Custom Pages migration checklist", "Determining if your Custom Page is affected", "JavaScript API changes", "Relativity-hosted assets changes", "Server-side requirements", "Frequently Asked Questions" ], "name": "Custom Pages migration checklist", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Migration of custom pages in Relativity aiR to the modernized compute platform", "title": "Custom Pages migration checklist" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Custom_Pages_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Custom_Pages_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.CustomPages assembly.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Custom Pages .NET API Reference", "Relativity.CustomPages" ], "headings": [ "Custom Pages .NET API Reference", "Relativity.CustomPages" ], "name": "Custom Pages .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.CustomPages assembly.", "title": "Custom Pages .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Customizing_the_UI.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Customizing_the_UI.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Custom pages", "headings": "Custom pages", "name": "Customize the UI", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Customize the UI" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/CustomPagesNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/CustomPagesNETAPI.html" }, "description": "Custom Pages .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Custom Pages .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Custom Pages .NET API Reference", "title": "Custom Pages .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Debug.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Debug.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Debug", "Supported Surface Area of relativity.debug", "data", "info", "Getting your application\u0027s information into the debug information" ], "headings": [ "Debug", "Supported Surface Area of relativity.debug", "data", "info", "Getting your application\u0027s information into the debug information" ], "name": "Debug", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Debug" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/ErrorApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/ErrorApi.htm" }, "description": "Use the relativity.internal.errorApi methods accessDenied and init to display error UIs, such as access denied overlays, from custom pages.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "errorApi", "Supported Surface Area of relativity.internal.errorApi", "accessDenied", "init", "noView", "permissionDenied", "workspaceVersion" ], "headings": [ "errorApi", "Supported Surface Area of relativity.internal.errorApi", "accessDenied", "init", "noView", "permissionDenied", "workspaceVersion" ], "name": "errorApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the relativity.internal.errorApi methods accessDenied and init to display error UIs, such as access denied overlays, from custom pages.", "title": "errorApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Find_the_main_window.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Find_the_main_window.htm" }, "description": "How to find the main window from your custom page", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "How to find the main window from your custom page", "headings": "How to find the main window from your custom page", "name": "How to find the main window from your custom page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "How to find the main window from your custom page", "title": "How to find the main window from your custom page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Internal.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Internal.htm" }, "description": "Use the relativity.internal object to check system state and interact with the system, including getApi, getClickTrackingElements, and isActive. Lists the supported surface area.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Internal", "Supported Surface Area of relativity.internal", "getApi", "getClickTrackingElements", "isActive", "isReady", "maximizeContent", "openSupport", "resetSessionExpirationTimeout", "restoreContent", "sessionActivityEvents", "toggleTabStrip", "Deprecated or Internally-used items" ], "headings": [ "Internal", "Supported Surface Area of relativity.internal", "getApi", "getClickTrackingElements", "isActive", "isReady", "maximizeContent", "openSupport", "resetSessionExpirationTimeout", "restoreContent", "sessionActivityEvents", "toggleTabStrip", "Deprecated or Internally-used items" ], "name": "Internal", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the relativity.internal object to check system state and interact with the system, including getApi, getClickTrackingElements, and isActive. Lists the supported surface area.", "title": "Internal" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Navigation.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Navigation.htm" }, "description": "Use the relativity.navigation object to navigate or redirect within Relativity, including navigate and navigateToForms, and to check recent navigation history.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Navigation", "Supported Surface Area of relativity.navigation", "navigate", "navigateToForms", "navigateToListPage", "navigateToReview", "open", "peekCurrentUrl", "peekPreviousUrl", "popAndNavigateToPreviousUrl", "pushStateAndRecent", "redirect", "redirectHandler", "toSearchOrDocument", "toTag" ], "headings": [ "Navigation", "Supported Surface Area of relativity.navigation", "navigate", "navigateToForms", "navigateToListPage", "navigateToReview", "open", "peekCurrentUrl", "peekPreviousUrl", "popAndNavigateToPreviousUrl", "pushStateAndRecent", "redirect", "redirectHandler", "toSearchOrDocument", "toTag" ], "name": "Navigation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the relativity.navigation object to navigate or redirect within Relativity, including navigate and navigateToForms, and to check recent navigation history.", "title": "Navigation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Publishing_and_uploading_custom_pages.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Publishing_and_uploading_custom_pages.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Publish and upload custom pages", "Publish your custom page project", "Upload a custom page file to Relativity", "Custom page layout fields" ], "headings": [ "Publish and upload custom pages", "Publish your custom page project", "Upload a custom page file to Relativity", "Custom page layout fields" ], "name": "Publish and upload custom pages", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Publish and upload custom pages" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Redirections.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Redirections.htm" }, "description": "Route redirections resulting from the migration of custom pages in Relativity aiR to the modernized compute platform", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "API replacements for route redirections", "Links and navigation", "Removed Routes" ], "headings": [ "API replacements for route redirections", "Links and navigation", "Removed Routes" ], "name": "API replacements for route redirections", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Route redirections resulting from the migration of custom pages in Relativity aiR to the modernized compute platform", "title": "API replacements for route redirections" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Removals.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Removals.htm" }, "description": "Removals and mitigation strategies resulting from the migration of custom pages in Relativity aiR to the modernized compute platform", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Removals and mitigation strategies", "Strategy: Migrate Into the Application", "Hosted External Frameworks/Libraries", "Strategy: Replace dialog and modal functions with your app\u0027s specific frameworks and libraries", "Strategy: Replace with native JavaScript functionality", "Strategy: Replace usage with a new PageBase API or existing API", "HEAP click tracking", "Configuration values", "Other functions and properties", "Obsolete: discontinue use" ], "headings": [ "Removals and mitigation strategies", "Strategy: Migrate Into the Application", "Hosted External Frameworks/Libraries", "Strategy: Replace dialog and modal functions with your app\u0027s specific frameworks and libraries", "Strategy: Replace with native JavaScript functionality", "Strategy: Replace usage with a new PageBase API or existing API", "HEAP click tracking", "Configuration values", "Other functions and properties", "Obsolete: discontinue use" ], "name": "Removals and mitigation strategies", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Removals and mitigation strategies resulting from the migration of custom pages in Relativity aiR to the modernized compute platform", "title": "Removals and mitigation strategies" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Supported_JavaScript_APIs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Supported_JavaScript_APIs.htm" }, "description": "Supported JavaScript APIs on Relativity\u0027s main window", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Supported JavaScript APIs on Relativity\u0027s main window", "Surface listing", "Details" ], "headings": [ "Supported JavaScript APIs on Relativity\u0027s main window", "Surface listing", "Details" ], "name": "Supported JavaScript APIs on Relativity\u0027s main window", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Supported JavaScript APIs on Relativity\u0027s main window", "title": "Supported JavaScript APIs on Relativity\u0027s main window" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Troubleshooting_custom_pages.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_the_UI/Troubleshooting_custom_pages.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Troubleshoot custom pages", "Remotely debug custom pages", "Custom page installation errors", "Custom pages not deployed", "Readiness check is falling", "ApplicationServer table out-of-date", "Mismatched versions of .dll files", "Can\u0027t access custom page", "Can\u0027t upload custom pages published through Visual Studio 2015 and higher", "Find a custom page\u0027s physical deployment", "Files system / IIS", "SQL" ], "headings": [ "Troubleshoot custom pages", "Remotely debug custom pages", "Custom page installation errors", "Custom pages not deployed", "Readiness check is falling", "ApplicationServer table out-of-date", "Mismatched versions of .dll files", "Can\u0027t access custom page", "Can\u0027t upload custom pages published through Visual Studio 2015 and higher", "Find a custom page\u0027s physical deployment", "Files system / IIS", "SQL" ], "name": "Troubleshoot custom pages", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Troubleshoot custom pages" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Adding_event_handlers_to_applications_or_objects.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Adding_event_handlers_to_applications_or_objects.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Add event handlers to applications", "headings": "Add event handlers to applications", "name": "Add event handlers to applications", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Add event handlers to applications" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Advanced_functionality_for_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Advanced_functionality_for_event_handlers.htm" }, "description": "You can further enhance the custom event handlers that you develop by incorporating advanced functionality in them.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Advanced functionality for event handlers", "Work with Choice field types", "Sample code for Choice fields", "Add assembly source information" ], "headings": [ "Advanced functionality for event handlers", "Work with Choice field types", "Sample code for Choice fields", "Add assembly source information" ], "name": "Advanced functionality for event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "You can further enhance the custom event handlers that you develop by incorporating advanced functionality in them.", "title": "Advanced functionality for event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Basic_concepts_for_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Basic_concepts_for_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Basic concepts for event handlers", "Common implementation tasks for event handlers", "Manipulate or validate data with event handlers" ], "headings": [ "Basic concepts for event handlers", "Common implementation tasks for event handlers", "Manipulate or validate data with event handlers" ], "name": "Basic concepts for event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Basic concepts for event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Best_practices_for_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Best_practices_for_event_handlers.htm" }, "description": "Use these guidelines to optimize your application development with event handlers.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Best practices for event handlers", "Use event handler coding conventions", "Use helper classes to create the client-side proxy", "Reference GUIDs", "Avoid using Choices with the same name", "Set the RunTarget attribute on event handlers", "Convert long running event handlers to agents" ], "headings": [ "Best practices for event handlers", "Use event handler coding conventions", "Use helper classes to create the client-side proxy", "Reference GUIDs", "Avoid using Choices with the same name", "Set the RunTarget attribute on event handlers", "Convert long running event handlers to agents" ], "name": "Best practices for event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use these guidelines to optimize your application development with event handlers.", "title": "Best practices for event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Building_your_first_event_handler.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Building_your_first_event_handler.htm" }, "description": "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 \u0026lt;your name\u0026gt;! The time is. \u0026lt;time\u0026gt;. 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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Build your first event handler", "Before you begin", "Build an event handler" ], "headings": [ "Build your first event handler", "Before you begin", "Build an event handler" ], "name": "Build your first event handler", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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 \u0026lt;your name\u0026gt;! The time is. \u0026lt;time\u0026gt;. 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.", "title": "Build your first event handler" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Console_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Console_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Console event handlers", "Guidelines for Console event handlers", "Code sample for a Console event handler" ], "headings": [ "Console event handlers", "Guidelines for Console event handlers", "Code sample for a Console event handler" ], "name": "Console event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Console event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Customizing_workflows.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Customizing_workflows.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Event Handlers", "headings": "Event Handlers", "name": "Event Handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Event Handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Developing_Mass_Operation_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Developing_Mass_Operation_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Develop Mass Operation handlers", "Guidelines for Mass Operation handlers", "Code sample for a Mass Operation handler", "Convert legacy custom mass operations" ], "headings": [ "Develop Mass Operation handlers", "Guidelines for Mass Operation handlers", "Code sample for a Mass Operation handler", "Convert legacy custom mass operations" ], "name": "Develop Mass Operation handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Develop Mass Operation handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Developing_object_type_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Developing_object_type_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Develop object type event handlers", "Using object type event handlers with Relativity Forms", "Using object type event handlers without Relativity Forms" ], "headings": [ "Develop object type event handlers", "Using object type event handlers with Relativity Forms", "Using object type event handlers without Relativity Forms" ], "name": "Develop object type event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Develop object type event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Event_Handler_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Event_Handler_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.EventHandler assembly.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Event Handler .NET API Reference", "Relativity.EventHandler" ], "headings": [ "Event Handler .NET API Reference", "Relativity.EventHandler" ], "name": "Event Handler .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.EventHandler assembly.", "title": "Event Handler .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/EventHandlerNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/EventHandlerNETAPI.html" }, "description": "Event Handler .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Event Handler .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Event Handler .NET API Reference", "title": "Event Handler .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/List_Page_Interaction_Event_Handler_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/List_Page_Interaction_Event_Handler_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "List Page Interaction Event Handler API", "JavaScript structure for event handlers", "Summary of JavaScript APIs", "Initializer API", "Event-specific APIs", "General APIs", "Initializer API details", "Event-specific API details", "Page Navigation API", "New Item Button API", "Cell Formatter API", "Data Source Override API", "View API", "Widget Menu Customization API", "General APIs details", "Initialization information", "startup info object", "Promise API", "Events API", "Kepler Provider API", "Common Utilities API", "Modal API", "Toolbar API", "CustomWidget API", "Additional information about dataSource objects", "dataSource.inboundTransformer", "dataSource.outboundTransformer" ], "headings": [ "List Page Interaction Event Handler API", "JavaScript structure for event handlers", "Summary of JavaScript APIs", "Initializer API", "Event-specific APIs", "General APIs", "Initializer API details", "Event-specific API details", "Page Navigation API", "New Item Button API", "Cell Formatter API", "Data Source Override API", "View API", "Widget Menu Customization API", "General APIs details", "Initialization information", "startup info object", "Promise API", "Events API", "Kepler Provider API", "Common Utilities API", "Modal API", "Toolbar API", "CustomWidget API", "Additional information about dataSource objects", "dataSource.inboundTransformer", "dataSource.outboundTransformer" ], "name": "List Page Interaction Event Handler API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "List Page Interaction Event Handler API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/List_Page_Interaction_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/List_Page_Interaction_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "List Page Interaction event handlers", "Special considerations for List Page Interaction event handlers", "Guidelines for List Page Interaction event handlers", "Code sample for a List Page Interaction event handler", "Sample JavaScript file", "Identifying the URL for a file", "Updating List Page Interaction event handlers" ], "headings": [ "List Page Interaction event handlers", "Special considerations for List Page Interaction event handlers", "Guidelines for List Page Interaction event handlers", "Code sample for a List Page Interaction event handler", "Sample JavaScript file", "Identifying the URL for a file", "Updating List Page Interaction event handlers" ], "name": "List Page Interaction event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "List Page Interaction event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Page_Interaction_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Page_Interaction_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Page Interaction event handlers", "Guidelines for Page Interaction event handlers", "Code sample for a Page Interaction event handler", "Helper method for custom page URLs" ], "headings": [ "Page Interaction event handlers", "Guidelines for Page Interaction event handlers", "Code sample for a Page Interaction event handler", "Helper method for custom page URLs" ], "name": "Page Interaction event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Page Interaction event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Post_Save_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Post_Save_event_handlers.htm" }, "description": "A Post Save event handler executes after a user clicks the Save or Save \u0026amp; 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 \u0026amp; 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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Post Save event handlers", "Guidelines for Post Save event handlers", "Code sample for a Post Save event handler" ], "headings": [ "Post Save event handlers", "Guidelines for Post Save event handlers", "Code sample for a Post Save event handler" ], "name": "Post Save event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "A Post Save event handler executes after a user clicks the Save or Save \u0026amp; 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 \u0026amp; 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.", "title": "Post Save event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Cascade_Delete_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Cascade_Delete_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pre Cascade Delete event handlers", "Guidelines for Pre Cascade Delete event handlers", "Code sample for a Pre Cascade Delete event handler" ], "headings": [ "Pre Cascade Delete event handlers", "Guidelines for Pre Cascade Delete event handlers", "Code sample for a Pre Cascade Delete event handler" ], "name": "Pre Cascade Delete event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Pre Cascade Delete event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Delete_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Delete_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pre Delete event handlers", "Guidelines for Pre Delete event handlers", "Code sample for a Pre Delete event handler" ], "headings": [ "Pre Delete event handlers", "Guidelines for Pre Delete event handlers", "Code sample for a Pre Delete event handler" ], "name": "Pre Delete event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Pre Delete event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Load_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Load_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pre Load event handlers", "Guidelines for Pre Load event handlers", "Code sample for a Pre Load event handler" ], "headings": [ "Pre Load event handlers", "Guidelines for Pre Load event handlers", "Code sample for a Pre Load event handler" ], "name": "Pre Load event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Pre Load event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Mass_Delete_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Mass_Delete_event_handlers.htm" }, "description": "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\u0027t require the assigned object to have object dependencies, so the Pre Mass Delete event handler is ideal for child objects that need to perform a single action when deleting many of them at once.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pre Mass Delete event handlers", "Guidelines for Pre Mass Delete event handlers", "Code sample for a Pre Mass Delete event handler" ], "headings": [ "Pre Mass Delete event handlers", "Guidelines for Pre Mass Delete event handlers", "Code sample for a Pre Mass Delete event handler" ], "name": "Pre Mass Delete event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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\u0027t require the assigned object to have object dependencies, so the Pre Mass Delete event handler is ideal for child objects that need to perform a single action when deleting many of them at once.", "title": "Pre Mass Delete event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Save_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Pre_Save_event_handlers.htm" }, "description": "Pre Save event handlers execute after a user changes field values and clicks the Save or Save \u0026amp; 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\u0027s stored. These event handlers are supported on document objects and Relativity Dynamic Objects (RDOs). If the criteria for a pre-save process aren\u0027t met, the operation can be aborted.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Pre Save event handlers", "Guidelines for Pre Save event handlers" ], "headings": [ "Pre Save event handlers", "Guidelines for Pre Save event handlers" ], "name": "Pre Save event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Pre Save event handlers execute after a user changes field values and clicks the Save or Save \u0026amp; 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\u0027s stored. These event handlers are supported on document objects and Relativity Dynamic Objects (RDOs). If the criteria for a pre-save process aren\u0027t met, the operation can be aborted.", "title": "Pre Save event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Redirecting_a_user_to_layout_in_a_Pre_Load_event_handler.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Redirecting_a_user_to_layout_in_a_Pre_Load_event_handler.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Redirect a user to a layout in a Pre Load event handler", "Sample code" ], "headings": [ "Redirect a user to a layout in a Pre Load event handler", "Sample code" ], "name": "Redirect a user to a layout in a Pre Load event handler", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Redirect a user to a layout in a Pre Load event handler" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Support_for_File_fields.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Support_for_File_fields.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Support for File fields", "Read a File field value", "Modify a File field value", "Clear a File field value" ], "headings": [ "Support for File fields", "Read a File field value", "Modify a File field value", "Clear a File field value" ], "name": "Support for File fields", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Support for File fields" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Troubleshooting_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Customizing_workflows/Troubleshooting_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Troubleshoot event handlers", "headings": "Troubleshoot event handlers", "name": "Troubleshoot event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Troubleshoot event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Downloads/Download_the_SDKs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Downloads/Download_the_SDKs.htm" }, "description": "You can download the most recent versions of the SDK installer from the Relativity Developers site.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Download the SDKs and NuGet packages", "Integration APIs", "Extension APIs" ], "headings": [ "Download the SDKs and NuGet packages", "Integration APIs", "Extension APIs" ], "name": "Downloading the SDK", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "You can download the most recent versions of the SDK installer from the Relativity Developers site.", "title": "Downloading the SDK" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Downloads/Relativity_templates_for_Visual_Studio.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Downloads/Relativity_templates_for_Visual_Studio.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Visual Studio templates", "Available Relativity templates", "Install the Relativity templates", "Download templates from Visual Studio Marketplace", "Add templates through Visual Studio", "Use the Relativity project templates", "Use the Relativity item templates", "Relativity Manager-Worker Agent template", "Agents", "Agents.NUnit", "CustomPages", "CustomPages.NUnit", "EventHandlers", "EventHandlers.NUnit", "Helpers", "Helpers.NUnit" ], "headings": [ "Visual Studio templates", "Available Relativity templates", "Install the Relativity templates", "Download templates from Visual Studio Marketplace", "Add templates through Visual Studio", "Use the Relativity project templates", "Use the Relativity item templates", "Relativity Manager-Worker Agent template", "Agents", "Agents.NUnit", "CustomPages", "CustomPages.NUnit", "EventHandlers", "EventHandlers.NUnit", "Helpers", "Helpers.NUnit" ], "name": "Visual Studio templates", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Visual Studio templates" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Explore/API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Explore/API_Reference.htm" }, "description": "Browse the available API references for .NET, REST, and JavaScript APIs using the table of contents or the list on this page.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "APIs Reference", "headings": "APIs Reference", "name": "APIs Reference Content", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the available API references for .NET, REST, and JavaScript APIs using the table of contents or the list on this page.", "title": "APIs Reference Content" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Explore/Explore.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Explore/Explore.htm" }, "description": "Start here to explore Relativity developer content, including what\u0027s new, getting started tutorials and platform API overviews, and links to tools and resources.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Explore the Relativity Platform", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Start here to explore Relativity developer content, including what\u0027s new, getting started tutorials and platform API overviews, and links to tools and resources.", "title": "Explore the Relativity Platform" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Explore/Introduction.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Explore/Introduction.htm" }, "description": "Introduction to Relativity aiR for Developers, the landing page for developer documentation.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity aiR for Developers", "Extending Relativity vs. Integrating with Relativity" ], "headings": [ "Relativity aiR for Developers", "Extending Relativity vs. Integrating with Relativity" ], "name": "Introduction to Relativity aiR for Developers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Introduction to Relativity aiR for Developers, the landing page for developer documentation.", "title": "Introduction to Relativity aiR for Developers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Explore/JS_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Explore/JS_API_Reference.htm" }, "description": "Browse the available JavaScript API references using the table of contents or the list on this page.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "JavaScript APIs Reference", "headings": "JavaScript APIs Reference", "name": "JavaScript APIs Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the available JavaScript API references using the table of contents or the list on this page.", "title": "JavaScript APIs Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Explore/NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Explore/NET_API_Reference.htm" }, "description": "Browse the available .NET API references using the table of contents or the list on this page.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": ".NET\u0026#160;APIs Reference", "headings": ".NET\u0026#160;APIs Reference", "name": ".NET APIs Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the available .NET API references using the table of contents or the list on this page.", "title": ".NET APIs Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Explore/Platform-APIs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Explore/Platform-APIs.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity aiR APIs", "Integration APIs", "Extension APIs" ], "headings": [ "Relativity aiR APIs", "Integration APIs", "Extension APIs" ], "name": "Relativity aiR APIs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity aiR APIs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Explore/REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Explore/REST_API_Reference.htm" }, "description": "Browse the available REST API references using the table of contents or the list on this page.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "REST APIs Reference", "headings": "REST APIs Reference", "name": "REST APIs Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the available REST API references using the table of contents or the list on this page.", "title": "REST APIs Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Explore/Tools-Resources.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Explore/Tools-Resources.htm" }, "description": "Find developer tools and resources, including the Developer Toolkit, local debugger, Publish to Relativity tool, NuGet packages, release notes, and documentation archives.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Developer Tools and Resources", "Developer Support", "Other Tools and utilities", "Sites" ], "headings": [ "Developer Tools and Resources", "Developer Support", "Other Tools and utilities", "Sites" ], "name": "Developer Tools and Resources", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find developer tools and resources, including the Developer Toolkit, local debugger, Publish to Relativity tool, NuGet packages, release notes, and documentation archives.", "title": "Developer Tools and Resources" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Explore/Tutorials.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Explore/Tutorials.htm" }, "description": "Find developer tutorials for integrating with and extending Relativity aiR, plus an advanced lesson series that builds a complete application importing Wikipedia data.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Developer Tutorials", "Integrating with Relativity", "Extending Relativity", "Advanced tutorials" ], "headings": [ "Developer Tutorials", "Integrating with Relativity", "Extending Relativity", "Advanced tutorials" ], "name": "Developer Tutorials", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find developer tutorials for integrating with and extending Relativity aiR, plus an advanced lesson series that builds a complete application importing Wikipedia data.", "title": "Developer Tutorials" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Extend/APIS-Services.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Extend/APIS-Services.htm" }, "description": "Find the extension APIs and services available for extending the Relativity platform.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Extension APIs and Services", "headings": "Extension APIs and Services", "name": "Integration APIs and Services", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find the extension APIs and services available for extending the Relativity platform.", "title": "Integration APIs and Services" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Extend/Extend.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Extend/Extend.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Extend the Relativity Platform", "headings": "Extend the Relativity Platform", "name": "Extend the Relativity Platform", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Extend the Relativity Platform" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Extend/Introduction.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Extend/Introduction.htm" }, "description": "Learn about the extensibility points for extending Relativity with .NET code, including agents, Kepler APIs, custom pages, event handlers, and API Helpers.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Extending Relativity", "Extensibility Points", "User Interface Customization APIs", "Extending Relativity vs. Integrating with Relativity" ], "headings": [ "Extending Relativity", "Extensibility Points", "User Interface Customization APIs", "Extending Relativity vs. Integrating with Relativity" ], "name": "Introduction to Relativity extensions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn about the extensibility points for extending Relativity with .NET code, including agents, Kepler APIs, custom pages, event handlers, and API Helpers.", "title": "Introduction to Relativity extensions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Extend/Tools-Resources.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Extend/Tools-Resources.htm" }, "description": "Find tools and resources for extension developers, including the Developer Toolkit, local debugger, Publish to Relativity tool, NuGet packages, and documentation archives.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Developer Tools and Resources", "Developer Support", "Other Tools and utilities", "Sites" ], "headings": [ "Developer Tools and Resources", "Developer Support", "Other Tools and utilities", "Sites" ], "name": "Developer Tools and Resources", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find tools and resources for extension developers, including the Developer Toolkit, local debugger, Publish to Relativity tool, NuGet packages, and documentation archives.", "title": "Developer Tools and Resources" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Extend/Tutorials.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Extend/Tutorials.htm" }, "description": "Find short tutorials on writing code, hosted on the Relativity Platform, that extends the standard functionality of Relativity aiR.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Tutorials for extending Relativity aiR", "headings": "Tutorials for extending Relativity aiR", "name": "Extension tutorials", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find short tutorials on writing code, hosted on the Relativity Platform, that extends the standard functionality of Relativity aiR.", "title": "Extension tutorials" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Action_Bar_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Action_Bar_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Action Bar Api", "Properties", "Methods", "Properties Details", "generate", "generateDefault", "isVisible : Boolean", "isVisible", "defaultActions", "createDefaultActionBar() ⇒ Promise", "destroy() ⇒ Promise" ], "headings": [ "Action Bar Api", "Properties", "Methods", "Properties Details", "generate", "generateDefault", "isVisible : Boolean", "isVisible", "defaultActions", "createDefaultActionBar() ⇒ Promise", "destroy() ⇒ Promise" ], "name": "Action Bar Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Action Bar Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Additional_Data_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Additional_Data_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Additional Data Api", "Methods", "Properties Details", "getDefaultFactoriesForAdditionalData(workspaceId, fieldsRequiringAdditionalData) ⇒ Array.\u0026lt;Object\u0026gt;" ], "headings": [ "Additional Data Api", "Methods", "Properties Details", "getDefaultFactoriesForAdditionalData(workspaceId, fieldsRequiringAdditionalData) ⇒ Array.\u0026lt;Object\u0026gt;" ], "name": "Additional Data Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Additional Data Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Application_Paths.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Application_Paths.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Application Paths", "Properties Details", "relativity : String", "kepler : String", "relativityRest : String" ], "headings": [ "Application Paths", "Properties Details", "relativity : String", "kepler : String", "relativityRest : String" ], "name": "Application Paths", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Application Paths" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Change_Pipeline.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Change_Pipeline.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Change Pipeline", "Change pipeline workflow", "Change pipeline event handlers", "Ambient variables", "pageInteraction", "validation" ], "headings": [ "Change Pipeline", "Change pipeline workflow", "Change pipeline event handlers", "Ambient variables", "pageInteraction", "validation" ], "name": "Change Pipeline", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Change Pipeline" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ColumnsApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ColumnsApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ColumnsApi", "Methods", "Properties Details", "setCustomFormatter(columnName, formatterAction) ⇒ undefined", "setFilterDataSource(columnName, filterDataSource) ⇒ undefined", "setLinkFormatter(columnName, options) ⇒ undefined", "removeColumn(columnName) ⇒ undefined", "setColumnTitle(columnName, title) ⇒ undefined" ], "headings": [ "ColumnsApi", "Methods", "Properties Details", "setCustomFormatter(columnName, formatterAction) ⇒ undefined", "setFilterDataSource(columnName, filterDataSource) ⇒ undefined", "setLinkFormatter(columnName, options) ⇒ undefined", "removeColumn(columnName) ⇒ undefined", "setColumnTitle(columnName, title) ⇒ undefined" ], "name": "ColumnsApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ColumnsApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Console_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Console_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Console Api", "Properties", "Methods", "Properties Details", "containersPromise ⇒ Promise", "generate", "isVisible ⇒ Boolean", "isVisible", "destroy() ⇒ Promise" ], "headings": [ "Console Api", "Properties", "Methods", "Properties Details", "containersPromise ⇒ Promise", "generate", "isVisible ⇒ Boolean", "isVisible", "destroy() ⇒ Promise" ], "name": "Console Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Console Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Constants_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Constants_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Constants Api", "Properties Details", "ACTION_TYPES : Object.\u0026lt;String, String\u0026gt;", "ACTION_THEMES : Object.\u0026lt;String, String\u0026gt;", "ACTIONS : Object.\u0026lt;String, String\u0026gt;", "ADMIN_WORKSPACE_ARTIFACT_ID : Number", "ARTIFACT_TYPE : Object.\u0026lt;String, Number\u0026gt;", "DISPLAYABLE_OBJECT_IDENTIFIER : Object.\u0026lt;String, String\u0026gt;", "EVENT_TYPE : Object.\u0026lt;String, Number\u0026gt;", "FORM_VIEW_MODEL_TYPE : Object.\u0026lt;String, Number\u0026gt;", "MESSAGE_CONTAINER_THEMES : Object.\u0026lt;String, String\u0026gt;", "MODAL_CLASSES : Object.\u0026lt;String, String\u0026gt;", "NAME_ID_PAIR : Object.\u0026lt;String, String\u0026gt;", "OBJECT_TYPE_IDENTIFIER : Object.\u0026lt;String, String\u0026gt;", "PERMISSION_ID : Object.\u0026lt;String, Number\u0026gt;", "PERMISSION_TYPE : Object.\u0026lt;String, Number\u0026gt;", "SELECTION_TYPE : Object.\u0026lt;String, String\u0026gt;", "VIEW_MODEL_NAME : Object.\u0026lt;String, String\u0026gt;", "SAVE_OPERATIONS : Object.\u0026lt;String, Number\u0026gt;", "KEYS : Array.\u0026lt;Object\u0026gt;", "HTTP_STATUS_CODE : Object.\u0026lt;String, Number\u0026gt;", "ITEM_LIST_COMMAND_COLUMN_TYPE : Object.\u0026lt;String, (String|null)\u0026gt;" ], "headings": [ "Constants Api", "Properties Details", "ACTION_TYPES : Object.\u0026lt;String, String\u0026gt;", "ACTION_THEMES : Object.\u0026lt;String, String\u0026gt;", "ACTIONS : Object.\u0026lt;String, String\u0026gt;", "ADMIN_WORKSPACE_ARTIFACT_ID : Number", "ARTIFACT_TYPE : Object.\u0026lt;String, Number\u0026gt;", "DISPLAYABLE_OBJECT_IDENTIFIER : Object.\u0026lt;String, String\u0026gt;", "EVENT_TYPE : Object.\u0026lt;String, Number\u0026gt;", "FORM_VIEW_MODEL_TYPE : Object.\u0026lt;String, Number\u0026gt;", "MESSAGE_CONTAINER_THEMES : Object.\u0026lt;String, String\u0026gt;", "MODAL_CLASSES : Object.\u0026lt;String, String\u0026gt;", "NAME_ID_PAIR : Object.\u0026lt;String, String\u0026gt;", "OBJECT_TYPE_IDENTIFIER : Object.\u0026lt;String, String\u0026gt;", "PERMISSION_ID : Object.\u0026lt;String, Number\u0026gt;", "PERMISSION_TYPE : Object.\u0026lt;String, Number\u0026gt;", "SELECTION_TYPE : Object.\u0026lt;String, String\u0026gt;", "VIEW_MODEL_NAME : Object.\u0026lt;String, String\u0026gt;", "SAVE_OPERATIONS : Object.\u0026lt;String, Number\u0026gt;", "KEYS : Array.\u0026lt;Object\u0026gt;", "HTTP_STATUS_CODE : Object.\u0026lt;String, Number\u0026gt;", "ITEM_LIST_COMMAND_COLUMN_TYPE : Object.\u0026lt;String, (String|null)\u0026gt;" ], "name": "Constants Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Constants Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ConvenienceAPI.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ConvenienceAPI.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ConvenienceAPI", "Properties Details", "Action Bar", "Additional Data", "Application Paths", "Console", "Constants", "Field", "Date Time", "File Field", "Item List Data Provider Factory", "Item List Helper", "I18n", "Layout", "Log Factory", "Modal Service", "Model Transformer", "Navigation", "Permission", "Popup Service", "Preview Security", "Promise Factory", "Relativity Forms Popup", "Static Text Helper", "Get Current Form State", "Relativity HTTP Client", "Review Queue Browser", "User", "Utilities", "Validation" ], "headings": [ "ConvenienceAPI", "Properties Details", "Action Bar", "Additional Data", "Application Paths", "Console", "Constants", "Field", "Date Time", "File Field", "Item List Data Provider Factory", "Item List Helper", "I18n", "Layout", "Log Factory", "Modal Service", "Model Transformer", "Navigation", "Permission", "Popup Service", "Preview Security", "Promise Factory", "Relativity Forms Popup", "Static Text Helper", "Get Current Form State", "Relativity HTTP Client", "Review Queue Browser", "User", "Utilities", "Validation" ], "name": "ConvenienceAPI", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ConvenienceAPI" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Date_Time_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Date_Time_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Date Time Api", "Methods", "Properties Details", "getFormatter(options) ⇒ Object" ], "headings": [ "Date Time Api", "Methods", "Properties Details", "getFormatter(options) ⇒ Object" ], "name": "Date Time Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Date Time Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Delete_Pipeline.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Delete_Pipeline.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Delete Pipeline", "Delete pipeline workflow", "Delete pipeline event handlers", "Ambient variables", "replaceReadDeleteDependencyList", "preDelete", "replaceDelete", "postDelete" ], "headings": [ "Delete Pipeline", "Delete pipeline workflow", "Delete pipeline event handlers", "Ambient variables", "replaceReadDeleteDependencyList", "preDelete", "replaceDelete", "postDelete" ], "name": "Delete Pipeline", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Delete Pipeline" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Field_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Field_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Field Api", "Methods", "Properties Details", "getValue(identifier) ⇒ Promise.\u0026lt;(Object|null)\u0026gt;", "getHtmlElement(identifier) ⇒ Promise.\u0026lt;(HTMLelement|null)\u0026gt;", "setIsEditMode(identifier, isEditMode) ⇒ Promise.\u0026lt;(Boolean|null)\u0026gt;", "setIsDisabled(identifier, isDisabled) ⇒ Promise.\u0026lt;(Boolean|null)\u0026gt;", "setIsLoading(identifier, isLoading) ⇒ Promise.\u0026lt;(undefined|null)\u0026gt;", "setContextualHelpText(identifier, [contextualHelpText]) ⇒ Promise.\u0026lt;(undefined|null)\u0026gt;", "addAdditionalData(identifier, additionalData) ⇒ Promise.\u0026lt;(undefined|null)\u0026gt;", "setIsHidden(identifier, isHidden) ⇒ Promise.\u0026lt;(Boolean|null)\u0026gt;", "setIsRequired(identifier, isRequired) ⇒ Promise.\u0026lt;(Boolean|null)\u0026gt;", "setValue(identifier, valueToSet) ⇒ Promise.\u0026lt;(Object|null)\u0026gt;", "setAriaDescribedby(identifier, ariaDescribedby) ⇒ Promise.\u0026lt;(String|null)\u0026gt;" ], "headings": [ "Field Api", "Methods", "Properties Details", "getValue(identifier) ⇒ Promise.\u0026lt;(Object|null)\u0026gt;", "getHtmlElement(identifier) ⇒ Promise.\u0026lt;(HTMLelement|null)\u0026gt;", "setIsEditMode(identifier, isEditMode) ⇒ Promise.\u0026lt;(Boolean|null)\u0026gt;", "setIsDisabled(identifier, isDisabled) ⇒ Promise.\u0026lt;(Boolean|null)\u0026gt;", "setIsLoading(identifier, isLoading) ⇒ Promise.\u0026lt;(undefined|null)\u0026gt;", "setContextualHelpText(identifier, [contextualHelpText]) ⇒ Promise.\u0026lt;(undefined|null)\u0026gt;", "addAdditionalData(identifier, additionalData) ⇒ Promise.\u0026lt;(undefined|null)\u0026gt;", "setIsHidden(identifier, isHidden) ⇒ Promise.\u0026lt;(Boolean|null)\u0026gt;", "setIsRequired(identifier, isRequired) ⇒ Promise.\u0026lt;(Boolean|null)\u0026gt;", "setValue(identifier, valueToSet) ⇒ Promise.\u0026lt;(Object|null)\u0026gt;", "setAriaDescribedby(identifier, ariaDescribedby) ⇒ Promise.\u0026lt;(String|null)\u0026gt;" ], "name": "Field Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Field Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/File_Field_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/File_Field_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "File Field Api", "Methods", "Properties Details", "downloadFile(workspaceId, artifactId, fieldId, fileName) ⇒ undefined", "uploadFile(workspaceId, artifactId, fieldId, file, backendProgressCallback, frontendProgressCallback, cancellationToken) ⇒ Promise" ], "headings": [ "File Field Api", "Methods", "Properties Details", "downloadFile(workspaceId, artifactId, fieldId, fileName) ⇒ undefined", "uploadFile(workspaceId, artifactId, fieldId, file, backendProgressCallback, frontendProgressCallback, cancellationToken) ⇒ Promise" ], "name": "File Field Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "File Field Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Form_Settings_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Form_Settings_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Form Settings Api", "Methods", "Type Definitions", "Properties Details", "getFormSettings() ⇒ FormSettings", "FormSettings" ], "headings": [ "Form Settings Api", "Methods", "Type Definitions", "Properties Details", "getFormSettings() ⇒ FormSettings", "FormSettings" ], "name": "Form Settings Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Form Settings Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/GetCurrentFormState.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/GetCurrentFormState.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "GetCurrentFormState", "Methods", "Properties Details", "getCurrentFormState() ⇒ FormViewModel" ], "headings": [ "GetCurrentFormState", "Methods", "Properties Details", "getCurrentFormState() ⇒ FormViewModel" ], "name": "GetCurrentFormState", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "GetCurrentFormState" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/i18n.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/i18n.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "i18n", "Methods", "Properties Details", "tr(key) ⇒ String", "getLocale() ⇒ String", "nf(options, lang) ⇒ Intl.NumberFormat", "df(options, lang) ⇒ Intl.DateTimeFormat", "addResources(lang, resources) ⇒ undefined" ], "headings": [ "i18n", "Methods", "Properties Details", "tr(key) ⇒ String", "getLocale() ⇒ String", "nf(options, lang) ⇒ Intl.NumberFormat", "df(options, lang) ⇒ Intl.DateTimeFormat", "addResources(lang, resources) ⇒ undefined" ], "name": "i18n", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "i18n" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Item_list_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Item_list_event_handlers.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Item list event handlers", "Summary of item list event handlers", "Summary of item list event handler APIs and objects", "Item List Event Handlers", "itemListModifyActions", "itemListModifyColumns", "itemListReloaded", "Item list APIs and Related Objects", "Item List Action button object", "View object", "Visibility Rule class" ], "headings": [ "Item list event handlers", "Summary of item list event handlers", "Summary of item list event handler APIs and objects", "Item List Event Handlers", "itemListModifyActions", "itemListModifyColumns", "itemListReloaded", "Item list APIs and Related Objects", "Item List Action button object", "View object", "Visibility Rule class" ], "name": "Item list event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Item list event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ItemList_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ItemList_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ItemList Api", "Methods", "Properties Details", "setCommandColumnType(itemListIdentifier, commandColumnType) ⇒ Promise.\u0026lt;(undefined|null)\u0026gt;" ], "headings": [ "ItemList Api", "Methods", "Properties Details", "setCommandColumnType(itemListIdentifier, commandColumnType) ⇒ Promise.\u0026lt;(undefined|null)\u0026gt;" ], "name": "ItemList Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ItemList Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/itemListActionsApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/itemListActionsApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "itemListActionsApi", "Methods", "Properties Details", "initialize() ⇒ undefined", "areActionsInitialized() ⇒ Boolean", "getActions() ⇒ Array.\u0026lt;Action\u0026gt; | null", "addDefaultActions() ⇒ undefined", "addAction(actionType, clickHandler, options) ⇒ Action | null", "removeActions(...actionTypes) ⇒ undefined", "differentiateActionsByItemListType() ⇒ undefined", "getGlobalVisibilityRules() ⇒ Object | null", "getSublistVisibilityRules() ⇒ Object | null", "checkActionsByVisibilityRules() ⇒ undefined", "checkPermissions() ⇒ Promise", "checkRulesAndPermissions() ⇒ Promise", "setCustomGetDataFunction(getDataFunction) ⇒ undefined" ], "headings": [ "itemListActionsApi", "Methods", "Properties Details", "initialize() ⇒ undefined", "areActionsInitialized() ⇒ Boolean", "getActions() ⇒ Array.\u0026lt;Action\u0026gt; | null", "addDefaultActions() ⇒ undefined", "addAction(actionType, clickHandler, options) ⇒ Action | null", "removeActions(...actionTypes) ⇒ undefined", "differentiateActionsByItemListType() ⇒ undefined", "getGlobalVisibilityRules() ⇒ Object | null", "getSublistVisibilityRules() ⇒ Object | null", "checkActionsByVisibilityRules() ⇒ undefined", "checkPermissions() ⇒ Promise", "checkRulesAndPermissions() ⇒ Promise", "setCustomGetDataFunction(getDataFunction) ⇒ undefined" ], "name": "itemListActionsApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "itemListActionsApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ItemListDataProviderFactory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/ItemListDataProviderFactory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ItemListDataProviderFactory", "Methods", "Properties Details", "create(providerType, options) ⇒ Object" ], "headings": [ "ItemListDataProviderFactory", "Methods", "Properties Details", "create(providerType, options) ⇒ Object" ], "name": "ItemListDataProviderFactory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ItemListDataProviderFactory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Layout_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Layout_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Layout Api", "Methods", "Properties Details", "removeFieldFromLayout(layoutData, id) ⇒ Object | null", "getFields(layoutData) ⇒ Array.\u0026lt;Object\u0026gt;", "getItemLists(layoutData) ⇒ Array.\u0026lt;Object\u0026gt;", "getCustomTexts(layoutData) ⇒ Array.\u0026lt;Object\u0026gt;", "getCategories(layoutData) ⇒ Array.\u0026lt;Object\u0026gt;" ], "headings": [ "Layout Api", "Methods", "Properties Details", "removeFieldFromLayout(layoutData, id) ⇒ Object | null", "getFields(layoutData) ⇒ Array.\u0026lt;Object\u0026gt;", "getItemLists(layoutData) ⇒ Array.\u0026lt;Object\u0026gt;", "getCustomTexts(layoutData) ⇒ Array.\u0026lt;Object\u0026gt;", "getCategories(layoutData) ⇒ Array.\u0026lt;Object\u0026gt;" ], "name": "Layout Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Layout Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Layout_representation_for_Relativity_forms.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Layout_representation_for_Relativity_forms.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Layout representation for Relativity forms", "Layout structure overview", "Summary of Layout components", "JSON data contracts", "Group", "Category", "Field", "CustomText", "ItemList", "View", "ViewField" ], "headings": [ "Layout representation for Relativity forms", "Layout structure overview", "Summary of Layout components", "JSON data contracts", "Group", "Category", "Field", "CustomText", "ItemList", "View", "ViewField" ], "name": "Layout representation for Relativity forms", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Layout representation for Relativity forms" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Load_Pipeline.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Load_Pipeline.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Load Pipeline", "Load pipeline workflow", "Load pipeline event handlers", "Ambient variables", "eventHandlersRegistered", "Syntax", "Parameters", "replaceRead", "Syntax", "Parameters", "Returns", "Syntax", "replaceGetNewObjectInstance", "Syntax", "Parameters", "transformLayout", "Syntax", "Parameters", "hydrateLayout", "Syntax", "Parameters", "hydrateLayoutComplete", "Syntax", "Parameters", "overridePickerDataSource", "Syntax", "Parameters", "The PickerDataSource object", "Parameters", "Return Value", "Examples", "Customizing the stock Data Provider", "replaceFileActions", "Syntax", "Parameters", "Parameters", "BackendProgressPayload", "BackendProgressMessage", "Sample Usage", "Sample Usage (XMLHttpRequest)", "Sample Usage (custom http client)", "Example", "Returns", "Example", "Parameters", "Returns", "Example", "replaceObtainAdditionalData", "Example", "Parameters", "Output", "The AdditionalData object", "If AdditionalData is an Array\u0026lt;Option\u0026gt;", "If AdditionalData is an Object", "The Option Object", "postObtainAdditionalData", "Syntax", "Parameters", "createActionBar", "Example", "Parameters", "Returns", "updateActionBar", "Syntax", "Parmaters", "Returns", "createConsole", "Syntax", "Parameters", "Returns", "updateConsole", "Example", "Parameters", "Returns", "pageLoadComplete", "Example", "Parameters" ], "headings": [ "Load Pipeline", "Load pipeline workflow", "Load pipeline event handlers", "Ambient variables", "eventHandlersRegistered", "Syntax", "Parameters", "replaceRead", "Syntax", "Parameters", "Returns", "Syntax", "replaceGetNewObjectInstance", "Syntax", "Parameters", "transformLayout", "Syntax", "Parameters", "hydrateLayout", "Syntax", "Parameters", "hydrateLayoutComplete", "Syntax", "Parameters", "overridePickerDataSource", "Syntax", "Parameters", "The PickerDataSource object", "Parameters", "Return Value", "Examples", "Customizing the stock Data Provider", "replaceFileActions", "Syntax", "Parameters", "Parameters", "BackendProgressPayload", "BackendProgressMessage", "Sample Usage", "Sample Usage (XMLHttpRequest)", "Sample Usage (custom http client)", "Example", "Returns", "Example", "Parameters", "Returns", "Example", "replaceObtainAdditionalData", "Example", "Parameters", "Output", "The AdditionalData object", "If AdditionalData is an Array\u0026lt;Option\u0026gt;", "If AdditionalData is an Object", "The Option Object", "postObtainAdditionalData", "Syntax", "Parameters", "createActionBar", "Example", "Parameters", "Returns", "updateActionBar", "Syntax", "Parmaters", "Returns", "createConsole", "Syntax", "Parameters", "Returns", "updateConsole", "Example", "Parameters", "Returns", "pageLoadComplete", "Example", "Parameters" ], "name": "Load Pipeline", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Load Pipeline" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Log_Factory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Log_Factory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Log Factory", "Methods", "Properties Details", "getLogger(id) ⇒ Logger" ], "headings": [ "Log Factory", "Methods", "Properties Details", "getLogger(id) ⇒ Logger" ], "name": "Log Factory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Log Factory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Modal_Service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Modal_Service.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Modal Service", "Methods", "Properties Details", "confirm(model, openModalHandler) ⇒ Promise", "openProgressModal(model, openModalHandler) ⇒ Promise", "openCustomModal(model, openModalHandler) ⇒ Promise", "openDeleteModal(model, openModalHandler) ⇒ Promise", "openMultiListPickerModal(model, openModalHandler) ⇒ Promise", "openSingleListPickerModal(model, openModalHandler) ⇒ Promise", "openKeyboardShortcutModal(model, openModalHandler) ⇒ Promise" ], "headings": [ "Modal Service", "Methods", "Properties Details", "confirm(model, openModalHandler) ⇒ Promise", "openProgressModal(model, openModalHandler) ⇒ Promise", "openCustomModal(model, openModalHandler) ⇒ Promise", "openDeleteModal(model, openModalHandler) ⇒ Promise", "openMultiListPickerModal(model, openModalHandler) ⇒ Promise", "openSingleListPickerModal(model, openModalHandler) ⇒ Promise", "openKeyboardShortcutModal(model, openModalHandler) ⇒ Promise" ], "name": "Modal Service", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Modal Service" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Model_Transformer_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Model_Transformer_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Model Transformer Api", "Properties", "Methods", "Properties Details", "defaultTransformers", "transformInbound(rules, dto) ⇒ Object", "transformOutbound(rules, modelData) ⇒ Object" ], "headings": [ "Model Transformer Api", "Properties", "Methods", "Properties Details", "defaultTransformers", "transformInbound(rules, dto) ⇒ Object", "transformOutbound(rules, modelData) ⇒ Object" ], "name": "Model Transformer Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Model Transformer Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Navigation_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Navigation_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Navigation Api", "Methods", "Properties Details", "navigateToArtifactId(requestedArtifactId, options) ⇒ Promise", "switchLayout(requestedLayoutId, options) ⇒ Promise", "navigateToForm(viewModelName, params, routerOptions, navigationOptions) ⇒ Promise" ], "headings": [ "Navigation Api", "Methods", "Properties Details", "navigateToArtifactId(requestedArtifactId, options) ⇒ Promise", "switchLayout(requestedLayoutId, options) ⇒ Promise", "navigateToForm(viewModelName, params, routerOptions, navigationOptions) ⇒ Promise" ], "name": "Navigation Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Navigation Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Permission_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Permission_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Permission Api", "Methods", "Properties Details", "canView() ⇒ Boolean | undefined", "canEdit() ⇒ Boolean | undefined", "canDelete() ⇒ Boolean | undefined", "canSecure() ⇒ Boolean | undefined", "canAdd() ⇒ Boolean | undefined", "canViewAudit() ⇒ Boolean | undefined" ], "headings": [ "Permission Api", "Methods", "Properties Details", "canView() ⇒ Boolean | undefined", "canEdit() ⇒ Boolean | undefined", "canDelete() ⇒ Boolean | undefined", "canSecure() ⇒ Boolean | undefined", "canAdd() ⇒ Boolean | undefined", "canViewAudit() ⇒ Boolean | undefined" ], "name": "Permission Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Permission Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Popup_Service_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Popup_Service_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Popup Service Api", "Methods", "Properties Details", "open(url, title, options) ⇒ Window | null" ], "headings": [ "Popup Service Api", "Methods", "Properties Details", "open(url, title, options) ⇒ Window | null" ], "name": "Popup Service Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Popup Service Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Preview_Security_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Preview_Security_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Preview Security Api", "Methods", "Properties Details", "openForGroup(groupArtifactId) ⇒ undefined" ], "headings": [ "Preview Security Api", "Methods", "Properties Details", "openForGroup(groupArtifactId) ⇒ undefined" ], "name": "Preview Security Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Preview Security Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Promise_Factory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Promise_Factory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Promise Factory", "Methods", "Properties Details", "resolve() ⇒ Promise", "reject() ⇒ Promise", "all() ⇒ Promise" ], "headings": [ "Promise Factory", "Methods", "Properties Details", "resolve() ⇒ Promise", "reject() ⇒ Promise", "all() ⇒ Promise" ], "name": "Promise Factory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Promise Factory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Relativity_Forms_Popup_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Relativity_Forms_Popup_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Forms Popup Api", "Methods", "Properties Details", "openAdd(config) ⇒ Object", "openEdit(config) ⇒ Object", "openView(config) ⇒ Object" ], "headings": [ "Relativity Forms Popup Api", "Methods", "Properties Details", "openAdd(config) ⇒ Object", "openEdit(config) ⇒ Object", "openView(config) ⇒ Object" ], "name": "Relativity Forms Popup Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Relativity Forms Popup Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/RelativityHTTPClient.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/RelativityHTTPClient.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "RelativityHTTPClient", "Methods", "Properties Details", "delete(url, requestOptions) ⇒ Promise", "get(url, requestOptions) ⇒ Promise", "post(url, payload, requestOptions) ⇒ Promise", "put(url, payload, requestOptions) ⇒ Promise", "makeRelativityRelativeUrl(url) ⇒ String", "makeRelativityBaseRequestOptions(extendWith) ⇒ Object", "makeRelativityRestRelativeUrl(url) ⇒ String", "makeRelativityRestBaseRequestOptions(extendWith) ⇒ Object" ], "headings": [ "RelativityHTTPClient", "Methods", "Properties Details", "delete(url, requestOptions) ⇒ Promise", "get(url, requestOptions) ⇒ Promise", "post(url, payload, requestOptions) ⇒ Promise", "put(url, payload, requestOptions) ⇒ Promise", "makeRelativityRelativeUrl(url) ⇒ String", "makeRelativityBaseRequestOptions(extendWith) ⇒ Object", "makeRelativityRestRelativeUrl(url) ⇒ String", "makeRelativityRestBaseRequestOptions(extendWith) ⇒ Object" ], "name": "RelativityHTTPClient", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "RelativityHTTPClient" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Review_Queue_Browser_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Review_Queue_Browser_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Review Queue Browser Api", "Properties", "Properties Details", "navigate", "currentQueueIndex : Number", "reviewQueueInformation : Object" ], "headings": [ "Review Queue Browser Api", "Properties", "Properties Details", "navigate", "currentQueueIndex : Number", "reviewQueueInformation : Object" ], "name": "Review Queue Browser Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Review Queue Browser Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Static_Text_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Static_Text_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Static Text Api", "Methods", "Properties Details", "retrieveAll() ⇒ Array.\u0026lt;Promise.\u0026lt;Object\u0026gt;\u0026gt; | null", "getValue(staticTextId) ⇒ Promise.\u0026lt;(String|null)\u0026gt;", "getHtmlElement(staticTextId) ⇒ Promise.\u0026lt;(Object|null)\u0026gt;", "setIsHidden(staticTextId, isHidden) ⇒ Promise.\u0026lt;(Boolean|null)\u0026gt;", "setValue(staticTextId, value) ⇒ Promise.\u0026lt;(String|null)\u0026gt;" ], "headings": [ "Static Text Api", "Methods", "Properties Details", "retrieveAll() ⇒ Array.\u0026lt;Promise.\u0026lt;Object\u0026gt;\u0026gt; | null", "getValue(staticTextId) ⇒ Promise.\u0026lt;(String|null)\u0026gt;", "getHtmlElement(staticTextId) ⇒ Promise.\u0026lt;(Object|null)\u0026gt;", "setIsHidden(staticTextId, isHidden) ⇒ Promise.\u0026lt;(Boolean|null)\u0026gt;", "setValue(staticTextId, value) ⇒ Promise.\u0026lt;(String|null)\u0026gt;" ], "name": "Static Text Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Static Text Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Submit_Pipeline.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Submit_Pipeline.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Submit Pipeline", "Submit pipeline workflow", "Submit pipeline event handlers", "Ambient variables", "preSave", "Syntax", "Parameters", "validation (on submit)", "Syntax", "Parameters", "Validation example", "replaceSave", "Syntax", "Parameters", "Example", "validateSave", "Syntax", "Parameters", "Example", "Example Error Message Output", "postSave", "Syntax", "Parameters", "pageUnload", "Syntax", "Parameters", "Example" ], "headings": [ "Submit Pipeline", "Submit pipeline workflow", "Submit pipeline event handlers", "Ambient variables", "preSave", "Syntax", "Parameters", "validation (on submit)", "Syntax", "Parameters", "Validation example", "replaceSave", "Syntax", "Parameters", "Example", "validateSave", "Syntax", "Parameters", "Example", "Example Error Message Output", "postSave", "Syntax", "Parameters", "pageUnload", "Syntax", "Parameters", "Example" ], "name": "Submit Pipeline", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Submit Pipeline" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/The_this_binding.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/The_this_binding.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "The this binding", "Properties", "Methods", "Properties Details", "artifactId ⇒ Number | Null", "artifactTypeId ⇒ Number | Null", "associatedArtifactId ⇒ Number | Null", "backingModelData ⇒ Object", "connectorFieldArtifactId ⇒ Number | Null", "exitDialog ⇒ Object", "fieldGuidToFieldIdMap ⇒ Object", "fieldNameToFieldIdMap ⇒ Map", "formViewModelTypeId ⇒ Number", "isDirty ⇒ Boolean", "isNew ⇒ Boolean", "lastVisitedArtifactId ⇒ Number", "layoutId ⇒ Number", "layoutMetadataCopy ⇒ Object", "parentArtifactId ⇒ Number", "viewModelName ⇒ String", "volatileModelData ⇒ Object", "workspaceId ⇒ Number", "clearErrorSummary() ⇒ undefined", "clearModelData() ⇒ undefined", "getFieldIdForField() ⇒ Number", "handleApplicationError(error) ⇒ undefined", "handlePermissionDeniedError() ⇒ undefined", "refreshLayout() ⇒ undefined", "setErrorSummary(messages, expand) ⇒ undefined" ], "headings": [ "The this binding", "Properties", "Methods", "Properties Details", "artifactId ⇒ Number | Null", "artifactTypeId ⇒ Number | Null", "associatedArtifactId ⇒ Number | Null", "backingModelData ⇒ Object", "connectorFieldArtifactId ⇒ Number | Null", "exitDialog ⇒ Object", "fieldGuidToFieldIdMap ⇒ Object", "fieldNameToFieldIdMap ⇒ Map", "formViewModelTypeId ⇒ Number", "isDirty ⇒ Boolean", "isNew ⇒ Boolean", "lastVisitedArtifactId ⇒ Number", "layoutId ⇒ Number", "layoutMetadataCopy ⇒ Object", "parentArtifactId ⇒ Number", "viewModelName ⇒ String", "volatileModelData ⇒ Object", "workspaceId ⇒ Number", "clearErrorSummary() ⇒ undefined", "clearModelData() ⇒ undefined", "getFieldIdForField() ⇒ Number", "handleApplicationError(error) ⇒ undefined", "handlePermissionDeniedError() ⇒ undefined", "refreshLayout() ⇒ undefined", "setErrorSummary(messages, expand) ⇒ undefined" ], "name": "The this binding", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "The this binding" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/User_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/User_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "User Api", "Methods", "Properties Details", "getCurrentAclUserId(workspaceId) ⇒ Promise" ], "headings": [ "User Api", "Methods", "Properties Details", "getCurrentAclUserId(workspaceId) ⇒ Promise" ], "name": "User Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "User Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Utility_Function_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Utility_Function_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Utility Function Api", "Methods", "Properties Details", "keyValueArrayToJsonArrayTransformer(arrayToTransform, inputValueKey) ⇒ Array", "getHtmlEventTarget(htmlEvent) ⇒ Object | null", "reload() ⇒ undefined", "createKeyValuePair(key, value) ⇒ Object", "getMainKeyCharCode(keys, charName) ⇒ Number", "getMainKeyFromCharCode(keys, charCode) ⇒ String", "escapeString(string) ⇒ String", "unescapeString(string) ⇒ String", "sanitizeHtmlString(string) ⇒ String", "getRelativityPageBaseWindow() ⇒ Object" ], "headings": [ "Utility Function Api", "Methods", "Properties Details", "keyValueArrayToJsonArrayTransformer(arrayToTransform, inputValueKey) ⇒ Array", "getHtmlEventTarget(htmlEvent) ⇒ Object | null", "reload() ⇒ undefined", "createKeyValuePair(key, value) ⇒ Object", "getMainKeyCharCode(keys, charName) ⇒ Number", "getMainKeyFromCharCode(keys, charCode) ⇒ String", "escapeString(string) ⇒ String", "unescapeString(string) ⇒ String", "sanitizeHtmlString(string) ⇒ String", "getRelativityPageBaseWindow() ⇒ Object" ], "name": "Utility Function Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Utility Function Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Validation_Api.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/FormsAPI/Validation_Api.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Validation Api", "Methods", "Properties Details", "getFailedSummaryObject(validationMessage) ⇒ Object", "getFailedFieldObject(fieldId, validationMessage) ⇒ Object", "getDefaultSummaryErrorForAction(actionName) ⇒ String", "getSilentFailureObject() ⇒ Object", "validateSaveResult(response, validationArray, options) ⇒ Promise.\u0026lt;Object\u0026gt;", "isValidInteger32(value) ⇒ Boolean", "isValidNonNegativeInteger32(value) ⇒ Boolean", "isValidPositiveInteger32(value) ⇒ Boolean", "isValidInteger64(value) ⇒ Boolean", "isValidNonNegativeInteger64(value) ⇒ Boolean", "isValidPositiveInteger64(value) ⇒ Boolean" ], "headings": [ "Validation Api", "Methods", "Properties Details", "getFailedSummaryObject(validationMessage) ⇒ Object", "getFailedFieldObject(fieldId, validationMessage) ⇒ Object", "getDefaultSummaryErrorForAction(actionName) ⇒ String", "getSilentFailureObject() ⇒ Object", "validateSaveResult(response, validationArray, options) ⇒ Promise.\u0026lt;Object\u0026gt;", "isValidInteger32(value) ⇒ Boolean", "isValidNonNegativeInteger32(value) ⇒ Boolean", "isValidPositiveInteger32(value) ⇒ Boolean", "isValidInteger64(value) ⇒ Boolean", "isValidNonNegativeInteger64(value) ⇒ Boolean", "isValidPositiveInteger64(value) ⇒ Boolean" ], "name": "Validation Api", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Validation Api" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Building_applications_101.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Building_applications_101.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Building applications 101", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Building applications 101" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_1_-_Set_up_your_developer_environment.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_1_-_Set_up_your_developer_environment.htm" }, "description": "Lesson 1 of the Get started series on setting up your Relativity developer environment. This topic has moved to a new location.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Lesson 1 - Set up your developer environment", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Lesson 1 of the Get started series on setting up your Relativity developer environment. This topic has moved to a new location.", "title": "Lesson 1 - Set up your developer environment" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_2_-_Build_an_application_without_any_code.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_2_-_Build_an_application_without_any_code.htm" }, "description": "Lesson 2 of the Get started series on building a Relativity application without any code. This topic has moved to a new location.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Lesson 2 - Build an application without any code", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Lesson 2 of the Get started series on building a Relativity application without any code. This topic has moved to a new location.", "title": "Lesson 2 - Build an application without any code" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_3_-_Create_a_RESTful_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_3_-_Create_a_RESTful_API.htm" }, "description": "Lesson 3 of the Get started series on creating a RESTful API for Relativity. This topic has moved to a new location.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Lesson 3 - Create a RESTful API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Lesson 3 of the Get started series on creating a RESTful API for Relativity. This topic has moved to a new location.", "title": "Lesson 3 - Create a RESTful API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_4_-_Validate_object_changes.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_4_-_Validate_object_changes.htm" }, "description": "Lesson 4 of the Get started series on validating object changes in Relativity. This topic has moved to a new location.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Lesson 4 - Validate object changes", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Lesson 4 of the Get started series on validating object changes in Relativity. This topic has moved to a new location.", "title": "Lesson 4 - Validate object changes" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_5_-_Build_a_cron_job.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_5_-_Build_a_cron_job.htm" }, "description": "Lesson 5 of the Get started series on building a cron job in Relativity. This topic has moved to a new location.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Lesson 5 - Build a cron job", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Lesson 5 of the Get started series on building a cron job in Relativity. This topic has moved to a new location.", "title": "Lesson 5 - Build a cron job" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_6_-_Create_a_custom_page.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_6_-_Create_a_custom_page.htm" }, "description": "Lesson 6 of the Get started series on creating a Relativity custom page. This topic has moved to a new location.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Lesson 6 - Create a custom page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Lesson 6 of the Get started series on creating a Relativity custom page. This topic has moved to a new location.", "title": "Lesson 6 - Create a custom page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_7_-_Use_Relativity_Forms_to_enhance_the_UI.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started/Lesson_7_-_Use_Relativity_Forms_to_enhance_the_UI.htm" }, "description": "Lesson 7 of the Get started series on using Relativity Forms to enhance the UI. This topic has moved to a new location.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Lesson 7 - Use Relativity Forms to enhance the UI", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Lesson 7 of the Get started series on using Relativity Forms to enhance the UI. This topic has moved to a new location.", "title": "Lesson 7 - Use Relativity Forms to enhance the UI" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Advanced_Tutorials.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Advanced_Tutorials.htm" }, "description": "Follow these lessons to build your first Relativity application by integrating with Relativity APIs, and learn who the tutorial series is designed for.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Learn about Relativity development", "Audience for this tutorial", "How to complete the tutorial", "Estimated completion time", "Considerations" ], "headings": [ "Learn about Relativity development", "Audience for this tutorial", "How to complete the tutorial", "Estimated completion time", "Considerations" ], "name": "Learn about Relativity development", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Follow these lessons to build your first Relativity application by integrating with Relativity APIs, and learn who the tutorial series is designed for.", "title": "Learn about Relativity development" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Build_a_cron_job.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Build_a_cron_job.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Lesson 4 - Build a cron job", "Step 1 - Create a basic agent", "Step 2 - Upload the agent to an application", "Step 3 - Update the agent functionality", "Step 4 - Write a unit test", "Step 5 - Verify that the agent runs" ], "headings": [ "Lesson 4 - Build a cron job", "Step 1 - Create a basic agent", "Step 2 - Upload the agent to an application", "Step 3 - Update the agent functionality", "Step 4 - Write a unit test", "Step 5 - Verify that the agent runs" ], "name": "Lesson 4 - Build a cron job", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Lesson 4 - Build a cron job" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Build_an_application_without_any_code.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Build_an_application_without_any_code.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Lesson 1 - Build an application without any code", "Step 1 - Create a new workspace through the Relativity UI", "Step 2 - Create an application in the workspace", "Step 3 - Create object types for your application", "Step 4 - Create fields for the application", "Step 5 - Update layouts to include fields for the application", "Step 6 - Update views to include fields for the application", "Step 7 - Set up tabs for the application", "Step 8 - Add sample data through the Relativity UI", "Step 9 - Create a dashboard", "Step 10 - Finalize and export application", "Step 11 - Install the application in a workspace", "Step 12 - Verify that the application built" ], "headings": [ "Lesson 1 - Build an application without any code", "Step 1 - Create a new workspace through the Relativity UI", "Step 2 - Create an application in the workspace", "Step 3 - Create object types for your application", "Step 4 - Create fields for the application", "Step 5 - Update layouts to include fields for the application", "Step 6 - Update views to include fields for the application", "Step 7 - Set up tabs for the application", "Step 8 - Add sample data through the Relativity UI", "Step 9 - Create a dashboard", "Step 10 - Finalize and export application", "Step 11 - Install the application in a workspace", "Step 12 - Verify that the application built" ], "name": "Lesson 1 - Build an application without any code", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Lesson 1 - Build an application without any code" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Create_a_custom_page.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Create_a_custom_page.htm" }, "description": "This tutorial illustrates how to create a simple custom page without using Visual Studio templates", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Lesson 5 - Create a custom page", "Step 1 - Create a simple custom page", "Step 2 - Deploy a custom page in Relativity", "Step 3 - Add client-side JavaScript to a custom page", "Step 4 - Debug your custom page", "Step 5 - Implement functionality for your custom page", "Step 6 - Add tests for your custom page logic", "Step 7 - Make your custom page production ready" ], "headings": [ "Lesson 5 - Create a custom page", "Step 1 - Create a simple custom page", "Step 2 - Deploy a custom page in Relativity", "Step 3 - Add client-side JavaScript to a custom page", "Step 4 - Debug your custom page", "Step 5 - Implement functionality for your custom page", "Step 6 - Add tests for your custom page logic", "Step 7 - Make your custom page production ready" ], "name": "Build a custom page", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This tutorial illustrates how to create a simple custom page without using Visual Studio templates", "title": "Build a custom page" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Create_a_RESTful_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Create_a_RESTful_API.htm" }, "description": "Follow Lesson 2 to use the Kepler framework to build a RESTful API that integrates with Wikipedia\u0027s public APIs and retrieves data in the required format.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Lesson 2 - Create a RESTful API", "Step 1 - Create an empty Kepler service", "Step 2 - Deploy to Relativity", "Step 3 - Test the deployed service", "Step 4 - Update the service", "Step 5 - Implement methods on an interface", "Step 6 - Write a unit test", "Step 7 - Deploy and verify" ], "headings": [ "Lesson 2 - Create a RESTful API", "Step 1 - Create an empty Kepler service", "Step 2 - Deploy to Relativity", "Step 3 - Test the deployed service", "Step 4 - Update the service", "Step 5 - Implement methods on an interface", "Step 6 - Write a unit test", "Step 7 - Deploy and verify" ], "name": "Lesson 2 - Create a RESTful API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Follow Lesson 2 to use the Kepler framework to build a RESTful API that integrates with Wikipedia\u0027s public APIs and retrieves data in the required format.", "title": "Lesson 2 - Create a RESTful API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Use_Relativity_Forms_to_enhance_the_UI.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Use_Relativity_Forms_to_enhance_the_UI.htm" }, "description": "Follow Lesson 6 to use Relativity Forms and a PageInteractionEventHandler to customize a layout, changing checkbox fields to toggles in the Hello Wikipedia application.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Lesson 6 - Use Relativity Forms to enhance the UI", "Step 1 - Pre-work", "Step 2 - Set up the project folders and create an event handler in Visual Studio", "Step 3 - Create a JavaScript file for an event handler", "Step 4 - Associate the event handler with an object type", "Step 5 - Add functionality to the JavaScript event handler", "Step 6 - Test your JavaScript", "Configure your development machine", "Configure your project", "Add files for unit testing", "Add a unit test", "Run the unit test" ], "headings": [ "Lesson 6 - Use Relativity Forms to enhance the UI", "Step 1 - Pre-work", "Step 2 - Set up the project folders and create an event handler in Visual Studio", "Step 3 - Create a JavaScript file for an event handler", "Step 4 - Associate the event handler with an object type", "Step 5 - Add functionality to the JavaScript event handler", "Step 6 - Test your JavaScript", "Configure your development machine", "Configure your project", "Add files for unit testing", "Add a unit test", "Run the unit test" ], "name": "Lesson 6 - Use Relativity Forms to enhance the UI", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Follow Lesson 6 to use Relativity Forms and a PageInteractionEventHandler to customize a layout, changing checkbox fields to toggles in the Hello Wikipedia application.", "title": "Lesson 6 - Use Relativity Forms to enhance the UI" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Validate_object_changes.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Get_started_RelativityOne/Validate_object_changes.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Lesson 3 - Validate object changes", "Step 1 - Implement a Pre Save event handler", "Step 2 - Upload the event handler assembly to Relativity", "Step 3 - Add validation logic to an event handler", "Step 4 - Make service calls from the event handler", "Step 5 - Write unit tests" ], "headings": [ "Lesson 3 - Validate object changes", "Step 1 - Implement a Pre Save event handler", "Step 2 - Upload the event handler assembly to Relativity", "Step 3 - Add validation logic to an event handler", "Step 4 - Make service calls from the event handler", "Step 5 - Write unit tests" ], "name": "Lesson 3 - Validate object changes", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Lesson 3 - Validate object changes" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Basic_REST_API_concepts.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Basic_REST_API_concepts.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Basic REST API concepts", "Tools", "URL", "Methods", "Headers", "Body", "Authentication", "Response", "Use Cases", "Troubleshooting" ], "headings": [ "Basic REST API concepts", "Tools", "URL", "Methods", "Headers", "Body", "Authentication", "Response", "Use Cases", "Troubleshooting" ], "name": "Basic REST API concepts", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Basic REST API concepts" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Basic_tutorials.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Basic_tutorials.htm" }, "description": "Find where the basic Relativity developer tutorials moved. This topic points to the Developer Tutorials content.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Basic tutorials", "headings": "Basic tutorials", "name": "Basic Tutorials", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find where the basic Relativity developer tutorials moved. This topic points to the Developer Tutorials content.", "title": "Basic Tutorials" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Core_Concepts.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Core_Concepts.htm" }, "description": "Landing page for core concepts you should know before developing with Relativity.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Core concepts for developers", "headings": "Core concepts for developers", "name": "Core Concepts for Developers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Landing page for core concepts you should know before developing with Relativity.", "title": "Core Concepts for Developers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Make_your_first_REST_call.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Make_your_first_REST_call.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Make your first REST call", "Before you begin", "API authentication", "Make your first REST call to Relativity", "Troubleshoot a REST call", "Not authenticated", "Incorrect HTTP Verb", "404 Not Found" ], "headings": [ "Make your first REST call", "Before you begin", "API authentication", "Make your first REST call to Relativity", "Troubleshoot a REST call", "Not authenticated", "Incorrect HTTP Verb", "404 Not Found" ], "name": "Make your first REST call", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Make your first REST call" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Object_Manager_-_A_Primer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Object_Manager_-_A_Primer.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Object Manager Fundamentals", "Sample use cases", "Required references", "Creating a connection to the service", "Object Manager service in .NET versus REST", "CRUDQ operations in Object Manager service", "Calls to QueryAsync() versus QuerySlimAsync() methods", "Sample .NET and REST calls", ".NET coding sample", "REST coding sample", "Considerations" ], "headings": [ "Object Manager Fundamentals", "Sample use cases", "Required references", "Creating a connection to the service", "Object Manager service in .NET versus REST", "CRUDQ operations in Object Manager service", "Calls to QueryAsync() versus QuerySlimAsync() methods", "Sample .NET and REST calls", ".NET coding sample", "REST coding sample", "Considerations" ], "name": "Object Manager Fundamentals", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Object Manager Fundamentals" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Relativity_artifact_identifiers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Relativity_artifact_identifiers.htm" }, "description": "You can identify Relativity artifacts of different types using Artifact ID and GUIDs.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity artifact identifiers", "Artifact ID", "Artifact type", "GUID" ], "headings": [ "Relativity artifact identifiers", "Artifact ID", "Artifact type", "GUID" ], "name": "Relativity artifact identifiers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "You can identify Relativity artifacts of different types using Artifact ID and GUIDs.", "title": "Relativity artifact identifiers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/SDK_and_Nuget_Compatibility.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/SDK_and_Nuget_Compatibility.htm" }, "description": "Find where SDK and NuGet compatibility information moved. This topic points to Download the SDKs and NuGet packages.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "SDK and Nuget Compatibility", "headings": "SDK and Nuget Compatibility", "name": "SDK and Nuget Compatibility", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find where SDK and NuGet compatibility information moved. This topic points to Download the SDKs and NuGet packages.", "title": "SDK and Nuget Compatibility" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Set_up_a_developer_environment.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Set_up_a_developer_environment.htm" }, "description": "Set up your environment for developing with Relativity aiR by installing the Relativity Visual Studio templates and setting up Relativity Community and DevHelp accounts.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Set up your developer environment", "Step 1 - Install the Relativity Visual Studio templates", "Step 2 - Set up Relativity Community and DevHelp accounts" ], "headings": [ "Set up your developer environment", "Step 1 - Install the Relativity Visual Studio templates", "Step 2 - Set up Relativity Community and DevHelp accounts" ], "name": "Set up your developer environment", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Set up your environment for developing with Relativity aiR by installing the Relativity Visual Studio templates and setting up Relativity Community and DevHelp accounts.", "title": "Set up your developer environment" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Storing_and_using_external_API_credentials.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Getting_Started/Storing_and_using_external_API_credentials.htm" }, "description": "Learn how to connect to external APIs from a Relativity extensibility point and pass credentials, using a pre-save event handler and Google\u0027s address validation API key as the example.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Storing and using external API credentials", "Before you begin", "Create the Relativity Dynamic Object (RDO)", "Build the extensibility point", "Store the credential", "Using Secret Store", "Using encrypted Instance Settings", "Fetch the API authentication information", "Call the API with authentication", "Test the validator" ], "headings": [ "Storing and using external API credentials", "Before you begin", "Create the Relativity Dynamic Object (RDO)", "Build the extensibility point", "Store the credential", "Using Secret Store", "Using encrypted Instance Settings", "Fetch the API authentication information", "Call the API with authentication", "Test the validator" ], "name": "Storing and using external API credentials", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn how to connect to external APIs from a Relativity extensibility point and pass credentials, using a pre-save event handler and Google\u0027s address validation API key as the example.", "title": "Storing and using external API credentials" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Builders.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Builders.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Import Service API builders", "ImportDocumentsSettingsBuilder", "ImportRdoSettingsBuilder", "DataSourceSettingsBuilder" ], "headings": [ "Import Service API builders", "ImportDocumentsSettingsBuilder", "ImportRdoSettingsBuilder", "DataSourceSettingsBuilder" ], "name": "Import Service API builders", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Import Service API builders" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Getting_Started.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Getting_Started.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Getting started with the Import Service API", "Prerequisites", "Authorization", "Permissions", "Make calls to import service", "HTTP clients", "Kepler .NET client", "Rate limit" ], "headings": [ "Getting started with the Import Service API", "Prerequisites", "Authorization", "Permissions", "Make calls to import service", "HTTP clients", "Kepler .NET client", "Rate limit" ], "name": "Getting started with the Import Service API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Getting started with the Import Service API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Import_data_into_RDOs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Import_data_into_RDOs.htm" }, "description": "Use the Import Service API to import data programmatically into existing Relativity Dynamic Objects (RDOs), including creating and configuring the import job.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Import data into RDOs", "Create import job", "Create import job configuration", "Add data source", "Begin import job", "End import job" ], "headings": [ "Import data into RDOs", "Create import job", "Create import job configuration", "Add data source", "Begin import job", "End import job" ], "name": "Import data into RDOs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Import Service API to import data programmatically into existing Relativity Dynamic Objects (RDOs), including creating and configuring the import job.", "title": "Import data into RDOs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Import_documents.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Import_documents.htm" }, "description": "Use the Import Service API to add documents to a workspace programmatically, including load file path considerations and creating the import job.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Import documents", "Considerations", "Create an import job", "Create an import job configuration", "Add data source", "Begin import job", "End import job" ], "headings": [ "Import documents", "Considerations", "Create an import job", "Create an import job configuration", "Add data source", "Begin import job", "End import job" ], "name": "Import documents", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Import Service API to add documents to a workspace programmatically, including load file path considerations and creating the import job.", "title": "Import documents" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Import_images.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Import_images.htm" }, "description": "Use the Import Service API to add images to Relativity programmatically, including creating and configuring the import job with curl and C# builder samples.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Import images", "Create import job", "Create import job configuration", "Add data source", "Begin import job", "End import job" ], "headings": [ "Import images", "Create import job", "Create import job configuration", "Add data source", "Begin import job", "End import job" ], "name": "Import images", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Import Service API to add images to Relativity programmatically, including creating and configuring the import job with curl and C# builder samples.", "title": "Import images" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Performance_Best_Practices.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Performance_Best_Practices.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Performance Best Practices", "Import Job Settings", "FileSizeColumnIndex" ], "headings": [ "Performance Best Practices", "Import Job Settings", "FileSizeColumnIndex" ], "name": "Performance Best Practices", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Performance Best Practices" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Sample_types_and_structure.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Getting_Started/Sample_types_and_structure.htm" }, "description": "Learn the types and structure of the Import Service API sample applications: .NET 7 console, Kepler client console, and PowerShell REST samples.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Samples types and structure", ".NET 7 Code Samples", "KeplerClient Code Samples", "Powershell Script Samples" ], "headings": [ "Samples types and structure", ".NET 7 Code Samples", "KeplerClient Code Samples", "Powershell Script Samples" ], "name": "Samples types and structure", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn the types and structure of the Import Service API sample applications: .NET 7 console, Kepler client console, and PowerShell REST samples.", "title": "Samples types and structure" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Import_Models_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Import_Models_NET_API_Reference.htm" }, "description": "Reference for the Relativity.Import.Models.SDK .NET API used with the Relativity Import Service API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Import Service Models .NET API Reference", "Relativity.Import.Models.SDK" ], "headings": [ "Import Service Models .NET API Reference", "Relativity.Import.Models.SDK" ], "name": "Import Service Models .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Reference for the Relativity.Import.Models.SDK .NET API used with the Relativity Import Service API.", "title": "Import Service Models .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Import_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Import_NET_API_Reference.htm" }, "description": "Reference for the Relativity.Import.SDK .NET API used with the Relativity Import Service API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Import Service .NET API Reference", "Relativity.Import.SDK" ], "headings": [ "Import Service .NET API Reference", "Relativity.Import.SDK" ], "name": "Import Service .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Reference for the Relativity.Import.SDK .NET API used with the Relativity Import Service API.", "title": "Import Service .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/ImportModelsNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/ImportModelsNETAPI.html" }, "description": "Import Service Models .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Import Service Models .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Import Service Models .NET API Reference", "title": "Import Service Models .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/ImportNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/ImportNETAPI.html" }, "description": "Import Service .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Import Service .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Import Service .NET API Reference", "title": "Import Service .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Overview/Handling_error_codes.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Overview/Handling_error_codes.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Handle Import Service API errors and exceptions", "Retrieving errors", "Error code structure", "Resources", "Actions", "Error types", "Error numbers" ], "headings": [ "Handle Import Service API errors and exceptions", "Retrieving errors", "Error code structure", "Resources", "Actions", "Error types", "Error numbers" ], "name": "Handle Import Service API errors and exceptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Handle Import Service API errors and exceptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Overview/Relativity_Import_Service_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Overview/Relativity_Import_Service_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Import Service API", "Version History", "Relativity.Import.SDK", "Relativity.Import.Models.SDK" ], "headings": [ "Relativity Import Service API", "Version History", "Relativity.Import.SDK", "Relativity.Import.Models.SDK" ], "name": "Relativity Import Service API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity Import Service API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Relativity_Import_Service_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/Relativity_Import_Service_REST_API_Reference.htm" }, "description": "REST API reference for the Relativity Import Service (Relativity.Import.Services).", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Import Service REST API Reference", "Relativity.Import.Services" ], "headings": [ "Relativity Import Service REST API Reference", "Relativity.Import.Services" ], "name": "Relativity Import Service REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "REST API reference for the Relativity Import Service (Relativity.Import.Services).", "title": "Relativity Import Service REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/RelativityImportService_API.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/RelativityImportService_API.html" }, "description": "Relativity Import Service API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity Import Service API REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity Import Service API REST Reference", "title": "Relativity Import Service API REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/RelativityImportService_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/RelativityImportService_REST_API_Reference.htm" }, "description": "REST API reference for the Relativity Import Service (Relativity.Import.Services).", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Import Service REST API Reference", "Relativity.Import.Services" ], "headings": [ "Relativity Import Service REST API Reference", "Relativity.Import.Services" ], "name": "Relativity Import Service REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "REST API reference for the Relativity Import Service (Relativity.Import.Services).", "title": "Relativity Import Service REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/RelativityImportServiceRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Import_API/Relativity_Import_Service_API/RelativityImportServiceRESTAPI.html" }, "description": "Relativity Import Service REST API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity Import Service REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity Import Service REST API Reference", "title": "Relativity Import Service REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/IncludedTopics.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/IncludedTopics.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Included Topics", "headings": "Included Topics", "name": "Included Topics", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Included Topics" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Integrate/APIS-Services.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Integrate/APIS-Services.htm" }, "description": "Landing page listing the integration APIs and services available for integrating with Relativity.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Integration APIs and Services", "headings": "Integration APIs and Services", "name": "Integration APIs and Services", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Landing page listing the integration APIs and services available for integrating with Relativity.", "title": "Integration APIs and Services" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Integrate/Fundamentals-and-concepts.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Integrate/Fundamentals-and-concepts.htm" }, "description": "Learn the fundamentals and basic concepts of integrating with Relativity, starting with an overview of the Relativity REST API and its REST services.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Integration fundamentals and concepts", "headings": "Integration fundamentals and concepts", "name": "Integration fundamentals and concepts", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn the fundamentals and basic concepts of integrating with Relativity, starting with an overview of the Relativity REST API and its REST services.", "title": "Integration fundamentals and concepts" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Integrate/Integrate.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Integrate/Integrate.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Integrate with the Relativity Platform", "headings": "Integrate with the Relativity Platform", "name": "Integrate with the Relativity Platform", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Integrate with the Relativity Platform" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Integrate/Introduction.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Integrate/Introduction.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Introduction to Relativity APIs", "Conventions \u0026amp; Standards", "API documentation", "Extending Relativity vs. Integrating with Relativity", "Extensibility maturity journey", "A PaaS beginning", "Adopting SaaS", "Direct data access focused APIs", "SaaS evolution", "Known challenges" ], "headings": [ "Introduction to Relativity APIs", "Conventions \u0026amp; Standards", "API documentation", "Extending Relativity vs. Integrating with Relativity", "Extensibility maturity journey", "A PaaS beginning", "Adopting SaaS", "Direct data access focused APIs", "SaaS evolution", "Known challenges" ], "name": "Introduction to Relativity APIs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Introduction to Relativity APIs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Integrate/Tools-Resources.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Integrate/Tools-Resources.htm" }, "description": "Find tools and resources for integrating with Relativity, including the integration APIs list, the Relativity NuGet Gallery, the Relativity aiR MCP, and external tools.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Integration Tools and Resources", "Relativity Tools and Resources", "External Tools and Resources" ], "headings": [ "Integration Tools and Resources", "Relativity Tools and Resources", "External Tools and Resources" ], "name": "Integration Tools and Resources", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Find tools and resources for integrating with Relativity, including the integration APIs list, the Relativity NuGet Gallery, the Relativity aiR MCP, and external tools.", "title": "Integration Tools and Resources" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Integrate/Tutorials.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Integrate/Tutorials.htm" }, "description": "Landing page for tutorials on building your own self-hosted applications that integrate with Relativity aiR.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Tutorials for integrating with Relativity aiR", "headings": "Tutorials for integrating with Relativity aiR", "name": "Integration tutorials", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Landing page for tutorials on building your own self-hosted applications that integrate with Relativity aiR.", "title": "Integration tutorials" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Cancellation_and_progress.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Cancellation_and_progress.htm" }, "description": "Learn how to cancel long-running Kepler service calls with a CancellationToken and how to return progress information while calls execute.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Cancellation and progress", "Cancellation", "Progress", "Long running process (LRP) vs Remote procedure call (RPC)", "Disposition of the proxy for progress and cancellation" ], "headings": [ "Cancellation and progress", "Cancellation", "Progress", "Long running process (LRP) vs Remote procedure call (RPC)", "Disposition of the proxy for progress and cancellation" ], "name": "Cancellation and progress", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn how to cancel long-running Kepler service calls with a CancellationToken and how to return progress information while calls execute.", "title": "Cancellation and progress" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Dependency_injection.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Dependency_injection.htm" }, "description": "Learn how the Kepler framework uses Castle Windsor for dependency injection, and how to register dependencies with a Windsor installer so controllers receive them.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Dependency Injection", "Dependency injection in the Kepler", "Assemblies without a Kepler service", "Dependency injection through ADS" ], "headings": [ "Dependency Injection", "Dependency injection in the Kepler", "Assemblies without a Kepler service", "Dependency injection through ADS" ], "name": "Dependency Injection", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn how the Kepler framework uses Castle Windsor for dependency injection, and how to register dependencies with a Windsor installer so controllers receive them.", "title": "Dependency Injection" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Deploy_Kepler_services_through_ADS.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Deploy_Kepler_services_through_ADS.htm" }, "description": "Deploy or update your Kepler service assemblies in Relativity through the Application Deployment System (ADS), and export services as part of an ADS application.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Deploy Kepler services through ADS", "Deploy a Kepler service", "Export a RAP with Kepler services", "Upgrade an application" ], "headings": [ "Deploy Kepler services through ADS", "Deploy a Kepler service", "Export a RAP with Kepler services", "Upgrade an application" ], "name": "Deploy Kepler services through ADS", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Deploy or update your Kepler service assemblies in Relativity through the Application Deployment System (ADS), and export services as part of an ADS application.", "title": "Deploy Kepler services through ADS" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/HTTP_headers__verbs__and_related_information.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/HTTP_headers__verbs__and_related_information.htm" }, "description": "Customize a Kepler service by setting the required X-CSRF-Header, specifying HTTP verbs with attributes, overriding status codes, and modifying REST responses.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "HTTP headers, verbs, and related information", "X-CSRF-Header", "HTTP verbs", "Status Codes", "ResponseController class", "Localization", "Query Parameters" ], "headings": [ "HTTP headers, verbs, and related information", "X-CSRF-Header", "HTTP verbs", "Status Codes", "ResponseController class", "Localization", "Query Parameters" ], "name": "HTTP headers, verbs, and related information", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Customize a Kepler service by setting the required X-CSRF-Header, specifying HTTP verbs with attributes, overriding status codes, and modifying REST responses.", "title": "HTTP headers, verbs, and related information" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_Client_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_Client_NET_API_Reference.htm" }, "description": "Reference for the Relativity.Kepler.Client.SDK .NET API used to call Kepler services from client code.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Kepler Client SDK .NET API Reference", "Relativity.Kepler.Client.SDK" ], "headings": [ "Kepler Client SDK .NET API Reference", "Relativity.Kepler.Client.SDK" ], "name": "Kepler Client SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Reference for the Relativity.Kepler.Client.SDK .NET API used to call Kepler services from client code.", "title": "Kepler Client SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_framework.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_framework.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Kepler framework", "Basic concepts and implementation workflow for a Kepler service", "Server-side implementation of Kepler service", "Client-side interactions with a Kepler service", "NuGet package for the Kepler framework", "Kepler FAQs", "Version History", "Relativity.Kepler.Client.SDK", "Relativity.Kepler.SDK" ], "headings": [ "Kepler framework", "Basic concepts and implementation workflow for a Kepler service", "Server-side implementation of Kepler service", "Client-side interactions with a Kepler service", "NuGet package for the Kepler framework", "Kepler FAQs", "Version History", "Relativity.Kepler.Client.SDK", "Relativity.Kepler.SDK" ], "name": "Kepler framework", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Kepler framework" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_NET_API_Reference.htm" }, "description": "Reference for the Relativity.Kepler .NET SDK API used to build Kepler services.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Kepler SDK .NET API Reference", "Relativity.Kepler" ], "headings": [ "Kepler SDK .NET API Reference", "Relativity.Kepler" ], "name": "Kepler SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Reference for the Relativity.Kepler .NET SDK API used to build Kepler services.", "title": "Kepler SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_service_structure_and_components.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Kepler_service_structure_and_components.htm" }, "description": "Learn how the Kepler framework uses modules, routing, exceptions, and versioning to detect and organize services, and how to deprecate outdated services.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Kepler service structure and components", "Modules", "Routing", "ServiceAudience attribute", "Interfaces", "Exceptions", "Versioning for Kepler APIs", "Example of a versioned service", "Obsolete attribute", "Deprecate a service", "Deprecate an endpoint" ], "headings": [ "Kepler service structure and components", "Modules", "Routing", "ServiceAudience attribute", "Interfaces", "Exceptions", "Versioning for Kepler APIs", "Example of a versioned service", "Obsolete attribute", "Deprecate a service", "Deprecate an endpoint" ], "name": "Kepler service structure and components", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn how the Kepler framework uses modules, routing, exceptions, and versioning to detect and organize services, and how to deprecate outdated services.", "title": "Kepler service structure and components" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/KeplerClientNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/KeplerClientNETAPI.html" }, "description": "Kepler Client SDK .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Kepler Client SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Kepler Client SDK .NET API Reference", "title": "Kepler Client SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/KeplerNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/KeplerNETAPI.html" }, "description": "Kepler SDK .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Kepler SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Kepler SDK .NET API Reference", "title": "Kepler SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Proxies_and_authentication.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Proxies_and_authentication.htm" }, "description": "Use the ServiceFactory class to create Kepler client proxies with bearer token or other credentials, and learn the available authentication methods.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Proxies and authentication", "ServiceFactory class", "Create a proxy using Bearer Token", "Create a proxy using username and password", "Client .NET proxy", "Authentication for Kepler services", "Oauth2 credentials", "Cookie authentication" ], "headings": [ "Proxies and authentication", "ServiceFactory class", "Create a proxy using Bearer Token", "Create a proxy using username and password", "Client .NET proxy", "Authentication for Kepler services", "Oauth2 credentials", "Cookie authentication" ], "name": "Proxies and authentication", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the ServiceFactory class to create Kepler client proxies with bearer token or other credentials, and learn the available authentication methods.", "title": "Proxies and authentication" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Serialization_and_streaming.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Serialization_and_streaming.htm" }, "description": "Learn how the Kepler framework serializes data as JSON by default, and how to implement custom serializers with IModelSerializer and custom streaming.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Serialization and streaming", "Serialization", "Custom serializers", "Custom deserializer", "Streaming", "Constructors for KeplerStream class", "Properties on KeplerStream class", "Method on KeplerStream class", "Special considerations for streaming" ], "headings": [ "Serialization and streaming", "Serialization", "Custom serializers", "Custom deserializer", "Streaming", "Constructors for KeplerStream class", "Properties on KeplerStream class", "Method on KeplerStream class", "Special considerations for streaming" ], "name": "Serialization and streaming", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn how the Kepler framework serializes data as JSON by default, and how to implement custom serializers with IModelSerializer and custom streaming.", "title": "Serialization and streaming" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Template_for_Kepler_services.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Template_for_Kepler_services.htm" }, "description": "Use the Relativity Kepler Project Template in Visual Studio to jump start a Kepler service, including prerequisites and creating a new service solution.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Template for Kepler services", "Before you begin", "Install the Relativity Kepler Project Template", "Create a new Kepler service solution", "Send requests to a service", "Uninstall the Relativity Kepler Project Template" ], "headings": [ "Template for Kepler services", "Before you begin", "Install the Relativity Kepler Project Template", "Create a new Kepler service solution", "Send requests to a service", "Uninstall the Relativity Kepler Project Template" ], "name": "Template for Kepler services", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Relativity Kepler Project Template in Visual Studio to jump start a Kepler service, including prerequisites and creating a new service solution.", "title": "Template for Kepler services" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Troubleshooting_Kepler_services.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Kepler_framework/Troubleshooting_Kepler_services.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Troubleshooting Kepler services", "Assembly doesn\u0027t contain service module", "Deleted applications", "GET endpoint fails", "Invalid RoutePrefix attribute causes 404 error", "Invalid WebService attribute causes 500 error", "Missing or no endpoints on a service", "Multiple modules error", "Multiple service implementations error", "Namespace doesn\u0027t exist error message", "ServiceAudience error" ], "headings": [ "Troubleshooting Kepler services", "Assembly doesn\u0027t contain service module", "Deleted applications", "GET endpoint fails", "Invalid RoutePrefix attribute causes 404 error", "Invalid WebService attribute causes 500 error", "Missing or no endpoints on a service", "Multiple modules error", "Multiple service implementations error", "Namespace doesn\u0027t exist error message", "ServiceAudience error" ], "name": "Troubleshooting Kepler services", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Troubleshooting Kepler services" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Legal_Hold_API/Legal_Hold_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Legal_Hold_API/Legal_Hold_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Legal Hold APIs", "Matter or project management", "ActiveCustodianSummary", "Creating a Legal Hold project", "Querying a Legal Hold project", "Querying for Custodians on a Legal Hold project", "Creating a communication", "Preservation in Place (PIP Application)", "Preserving data", "Releasing data", "Closing preservation", "HR Integrations", "Creating an entity", "Updating entity employee status", "Task Management", "Creating a Legal Hold task", "Updating Legal Hold task status" ], "headings": [ "Legal Hold APIs", "Matter or project management", "ActiveCustodianSummary", "Creating a Legal Hold project", "Querying a Legal Hold project", "Querying for Custodians on a Legal Hold project", "Creating a communication", "Preservation in Place (PIP Application)", "Preserving data", "Releasing data", "Closing preservation", "HR Integrations", "Creating an entity", "Updating entity employee status", "Task Management", "Creating a Legal Hold task", "Updating Legal Hold task status" ], "name": "Legal Hold API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Legal Hold API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Legal_Hold_API/Legal_Hold_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Legal_Hold_API/Legal_Hold_REST_API_Reference.htm" }, "description": "REST API reference for the Legal Hold services (kCura.LegalHold.Services).", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Legal Hold REST API Reference", "kCura.LegalHold.Services" ], "headings": [ "Legal Hold REST API Reference", "kCura.LegalHold.Services" ], "name": "Legal Hold REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "REST API reference for the Legal Hold services (kCura.LegalHold.Services).", "title": "Legal Hold REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Legal_Hold_API/LegalHoldRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Legal_Hold_API/LegalHoldRESTAPI.html" }, "description": "Legal Hold API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Legal Hold REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Legal Hold API REST Reference", "title": "Legal Hold REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Class_FilterNode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Class_FilterNode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Class: FilterNode", "Constructors", "Properties", "Methods", "Constructors", "constructor", "Properties", "info", "left", "right", "Methods", "toString" ], "headings": [ "Class: FilterNode", "Constructors", "Properties", "Methods", "Constructors", "constructor", "Properties", "info", "left", "right", "Methods", "toString" ], "name": "Class: FilterNode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Class: FilterNode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Class_FilterState.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Class_FilterState.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Class: FilterState", "Constructors", "Properties", "Constructors", "constructor", "Properties", "filtersBrowserMap", "sampling", "savedSearch" ], "headings": [ "Class: FilterState", "Constructors", "Properties", "Constructors", "constructor", "Properties", "filtersBrowserMap", "sampling", "savedSearch" ], "name": "Class: FilterState", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Class: FilterState" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Class_SampleState.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Class_SampleState.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Class: SampleState", "Constructors", "Properties", "Constructors", "constructor", "Properties", "sampleDetailsMap", "sampleParametersMap" ], "headings": [ "Class: SampleState", "Constructors", "Properties", "Constructors", "constructor", "Properties", "sampleDetailsMap", "sampleParametersMap" ], "name": "Class: SampleState", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Class: SampleState" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_BrowserID.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_BrowserID.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: BrowserID", "Enumeration Members", "Enumeration Members", "default", "fieldTree", "folder", "folderScope", "savedSearch", "savedSearchCondition", "savedSearchFolder" ], "headings": [ "Enumeration: BrowserID", "Enumeration Members", "Enumeration Members", "default", "fieldTree", "folder", "folderScope", "savedSearch", "savedSearchCondition", "savedSearchFolder" ], "name": "Enumeration: BrowserID", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: BrowserID" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_DataSourceID.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_DataSourceID.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: DataSourceID", "Enumeration Members", "Enumeration Members", "itemList" ], "headings": [ "Enumeration: DataSourceID", "Enumeration Members", "Enumeration Members", "itemList" ], "name": "Enumeration: DataSourceID", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: DataSourceID" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_NODE_TYPE.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_NODE_TYPE.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: FILTER_NODE_TYPE", "Enumeration Members", "Enumeration Members", "OPERAND", "OPERATOR" ], "headings": [ "Enumeration: FILTER_NODE_TYPE", "Enumeration Members", "Enumeration Members", "OPERAND", "OPERATOR" ], "name": "Enumeration: FILTER_NODE_TYPE", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: FILTER_NODE_TYPE" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_OPERATOR.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_OPERATOR.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: FILTER_OPERATOR", "Enumeration Members", "Enumeration Members", "AND", "NONE", "OR", "PARENTHESES" ], "headings": [ "Enumeration: FILTER_OPERATOR", "Enumeration Members", "Enumeration Members", "AND", "NONE", "OR", "PARENTHESES" ], "name": "Enumeration: FILTER_OPERATOR", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: FILTER_OPERATOR" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_TREE_NAMES.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_TREE_NAMES.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: FILTER_TREE_NAMES", "Enumeration Members", "Enumeration Members", "global", "hidden", "user", "userGlobal", "widgetNative" ], "headings": [ "Enumeration: FILTER_TREE_NAMES", "Enumeration Members", "Enumeration Members", "global", "hidden", "user", "userGlobal", "widgetNative" ], "name": "Enumeration: FILTER_TREE_NAMES", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: FILTER_TREE_NAMES" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_TYPES.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_TYPES.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: FILTER_TYPES", "Enumeration Members", "Enumeration Members", "CLUSTER", "DEFAULT", "FIELD_TREE", "FOLDER", "PRESERVED_FILTERS", "SAVED_SEARCH" ], "headings": [ "Enumeration: FILTER_TYPES", "Enumeration Members", "Enumeration Members", "CLUSTER", "DEFAULT", "FIELD_TREE", "FOLDER", "PRESERVED_FILTERS", "SAVED_SEARCH" ], "name": "Enumeration: FILTER_TYPES", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: FILTER_TYPES" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_UPDATE_ACTIONS.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_FILTER_UPDATE_ACTIONS.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: FILTER_UPDATE_ACTIONS", "Enumeration Members", "Enumeration Members", "ADD", "MODIFY", "REMOVE", "REPLACE" ], "headings": [ "Enumeration: FILTER_UPDATE_ACTIONS", "Enumeration Members", "Enumeration Members", "ADD", "MODIFY", "REMOVE", "REPLACE" ], "name": "Enumeration: FILTER_UPDATE_ACTIONS", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: FILTER_UPDATE_ACTIONS" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_LongTextBehavior.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_LongTextBehavior.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: LongTextBehavior", "Enumeration Members", "Enumeration Members", "Default", "DefaultWithErrors", "Tokenized", "TokenizedWithErrors" ], "headings": [ "Enumeration: LongTextBehavior", "Enumeration Members", "Enumeration Members", "Default", "DefaultWithErrors", "Tokenized", "TokenizedWithErrors" ], "name": "Enumeration: LongTextBehavior", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: LongTextBehavior" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_ToolbarContentSlotName.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_ToolbarContentSlotName.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ToolbarContentSlotName", "Enumeration Members", "Enumeration Members", "center", "left", "right" ], "headings": [ "Enumeration: ToolbarContentSlotName", "Enumeration Members", "Enumeration Members", "center", "left", "right" ], "name": "Enumeration: ToolbarContentSlotName", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ToolbarContentSlotName" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_TreeNodeType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Enumeration_TreeNodeType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: TreeNodeType", "Enumeration Members", "Enumeration Members", "fieldTree_field", "fieldTree_folder", "fieldTree_root", "folderTree_folder", "folderTree_root", "searchTree_folder", "searchTree_root", "searchTree_search" ], "headings": [ "Enumeration: TreeNodeType", "Enumeration Members", "Enumeration Members", "fieldTree_field", "fieldTree_folder", "fieldTree_root", "folderTree_folder", "folderTree_root", "searchTree_folder", "searchTree_root", "searchTree_search" ], "name": "Enumeration: TreeNodeType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: TreeNodeType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ActiveObjectTypeProperties.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ActiveObjectTypeProperties.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ActiveObjectTypeProperties", "Properties", "Properties", "guid", "pivotEnabled", "samplingEnabled", "supportsViews" ], "headings": [ "Interface: ActiveObjectTypeProperties", "Properties", "Properties", "guid", "pivotEnabled", "samplingEnabled", "supportsViews" ], "name": "Interface: ActiveObjectTypeProperties", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ActiveObjectTypeProperties" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ActiveObjectTypePropertiesApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ActiveObjectTypePropertiesApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ActiveObjectTypePropertiesApi", "Properties", "Properties", "getProperties" ], "headings": [ "Interface: ActiveObjectTypePropertiesApi", "Properties", "Properties", "getProperties" ], "name": "Interface: ActiveObjectTypePropertiesApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ActiveObjectTypePropertiesApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ActiveSearchInfo.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ActiveSearchInfo.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ActiveSearchInfo", "Properties", "Properties", "activeRelationalFieldID", "isAdHoc", "savedSearchId", "savedSearchSearchProviderId", "savedSearchSorts", "viewFieldIds" ], "headings": [ "Interface: ActiveSearchInfo", "Properties", "Properties", "activeRelationalFieldID", "isAdHoc", "savedSearchId", "savedSearchSearchProviderId", "savedSearchSorts", "viewFieldIds" ], "name": "Interface: ActiveSearchInfo", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ActiveSearchInfo" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_BrowserPanelState.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_BrowserPanelState.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: BrowserPanelState", "Hierarchy", "Properties", "Properties", "default", "fieldTree", "folder", "folderScope", "savedSearch", "savedSearchCondition", "savedSearchFolder", "selectedBrowser" ], "headings": [ "Interface: BrowserPanelState", "Hierarchy", "Properties", "Properties", "default", "fieldTree", "folder", "folderScope", "savedSearch", "savedSearchCondition", "savedSearchFolder", "selectedBrowser" ], "name": "Interface: BrowserPanelState", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: BrowserPanelState" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_BrowserState.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_BrowserState.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: BrowserState", "Properties", "Properties", "expandedNodes", "includeSubfolders", "selectedNode", "selectedNodeAncestorIDs", "selectedNodeParent", "selectedNodeSearchType", "selectedNodeType" ], "headings": [ "Interface: BrowserState", "Properties", "Properties", "expandedNodes", "includeSubfolders", "selectedNode", "selectedNodeAncestorIDs", "selectedNodeParent", "selectedNodeSearchType", "selectedNodeType" ], "name": "Interface: BrowserState", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: BrowserState" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConfigApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConfigApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ConfigApi", "Properties", "Properties", "getConfig", "onConfigLoaded", "setConfig" ], "headings": [ "Interface: ConfigApi", "Properties", "Properties", "getConfig", "onConfigLoaded", "setConfig" ], "name": "Interface: ConfigApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ConfigApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConfigSettings.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConfigSettings.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ConfigSettings", "Indexable", "Properties", "Methods", "Properties", "customMassOps", "hideCommandColumn", "hideExportDashboard", "massOpsToHide", "useHydroPreviewPane", "Methods", "resetPropertyValues" ], "headings": [ "Interface: ConfigSettings", "Indexable", "Properties", "Methods", "Properties", "customMassOps", "hideCommandColumn", "hideExportDashboard", "massOpsToHide", "useHydroPreviewPane", "Methods", "resetPropertyValues" ], "name": "Interface: ConfigSettings", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ConfigSettings" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConfirmModalModel.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConfirmModalModel.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ConfirmModalModel", "Properties", "Properties", "acceptAction", "acceptIsDestructive", "acceptText", "cancelAction", "cancelText", "closeOnAcceptActionFailure", "disableAcceptButtonAfterClick", "focusEls", "message", "title" ], "headings": [ "Interface: ConfirmModalModel", "Properties", "Properties", "acceptAction", "acceptIsDestructive", "acceptText", "cancelAction", "cancelText", "closeOnAcceptActionFailure", "disableAcceptButtonAfterClick", "focusEls", "message", "title" ], "name": "Interface: ConfirmModalModel", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ConfirmModalModel" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConvenienceApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ConvenienceApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ConvenienceApi", "Properties", "Properties", "activeObjectTypeProperties", "artifactID", "artifactTypeID", "dashboardData", "dashboardID", "dashboardName", "massProcesses", "relativityHttpClient", "servicePathOverrides", "toggles", "useLiquidForms", "userTimezone", "utilities", "viewID", "workspaceID" ], "headings": [ "Interface: ConvenienceApi", "Properties", "Properties", "activeObjectTypeProperties", "artifactID", "artifactTypeID", "dashboardData", "dashboardID", "dashboardName", "massProcesses", "relativityHttpClient", "servicePathOverrides", "toggles", "useLiquidForms", "userTimezone", "utilities", "viewID", "workspaceID" ], "name": "Interface: ConvenienceApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ConvenienceApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_CustomConditionApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_CustomConditionApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: CustomConditionApi", "Properties", "Properties", "registerCustomCondition" ], "headings": [ "Interface: CustomConditionApi", "Properties", "Properties", "registerCustomCondition" ], "name": "Interface: CustomConditionApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: CustomConditionApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_CustomConditionCallbackResponse.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_CustomConditionCallbackResponse.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: CustomConditionCallbackResponse", "Hierarchy", "Properties", "Properties", "condition", "wasCancelled" ], "headings": [ "Interface: CustomConditionCallbackResponse", "Hierarchy", "Properties", "Properties", "condition", "wasCancelled" ], "name": "Interface: CustomConditionCallbackResponse", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: CustomConditionCallbackResponse" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_CustomModalModel.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_CustomModalModel.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: CustomModalModel", "Properties", "Properties", "actions", "contentElement", "noActions", "noHeader", "size", "title" ], "headings": [ "Interface: CustomModalModel", "Properties", "Properties", "actions", "contentElement", "noActions", "noHeader", "size", "title" ], "name": "Interface: CustomModalModel", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: CustomModalModel" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_DashboardApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_DashboardApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: DashboardApi", "Properties", "Properties", "shouldShowDashboardsDropdown" ], "headings": [ "Interface: DashboardApi", "Properties", "Properties", "shouldShowDashboardsDropdown" ], "name": "Interface: DashboardApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: DashboardApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_DataSourceApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_DataSourceApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: DataSourceApi", "Properties", "Properties", "dataSourceExists", "getFieldCollection", "registerColumnFormatter", "registerDataSource", "registerOverrideOperators", "retrieveDataSource" ], "headings": [ "Interface: DataSourceApi", "Properties", "Properties", "dataSourceExists", "getFieldCollection", "registerColumnFormatter", "registerDataSource", "registerOverrideOperators", "retrieveDataSource" ], "name": "Interface: DataSourceApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: DataSourceApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_EventHandlerStatus.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_EventHandlerStatus.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: EventHandlerStatus", "Properties", "Properties", "FailingEventHandler", "Message", "Success" ], "headings": [ "Interface: EventHandlerStatus", "Properties", "Properties", "FailingEventHandler", "Message", "Success" ], "name": "Interface: EventHandlerStatus", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: EventHandlerStatus" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ExternalModalModel.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ExternalModalModel.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ExternalModalModel", "Properties", "Properties", "closeAction", "cssClass", "focusEls", "height", "url", "width" ], "headings": [ "Interface: ExternalModalModel", "Properties", "Properties", "closeAction", "cssClass", "focusEls", "height", "url", "width" ], "name": "Interface: ExternalModalModel", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ExternalModalModel" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_Field.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_Field.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: Field", "Properties", "Properties", "ArtifactID", "FieldCategory", "FieldType", "Guids", "Name", "ViewFieldID" ], "headings": [ "Interface: Field", "Properties", "Properties", "ArtifactID", "FieldCategory", "FieldType", "Guids", "Name", "ViewFieldID" ], "name": "Interface: Field", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: Field" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FieldRef.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FieldRef.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FieldRef", "Hierarchy", "Properties", "Properties", "ArtifactID", "Guid", "Guids", "Name", "ViewFieldID", "artifactID", "name" ], "headings": [ "Interface: FieldRef", "Hierarchy", "Properties", "Properties", "ArtifactID", "Guid", "Guids", "Name", "ViewFieldID", "artifactID", "name" ], "name": "Interface: FieldRef", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FieldRef" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FieldTypeRegistryApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FieldTypeRegistryApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FieldTypeRegistryApi", "Properties", "Properties", "getField", "getFieldNamePerArtifactId", "getFieldTypeIdForField", "registerFieldWithFieldType", "registerSupplementalFieldData" ], "headings": [ "Interface: FieldTypeRegistryApi", "Properties", "Properties", "getField", "getFieldNamePerArtifactId", "getFieldTypeIdForField", "registerFieldWithFieldType", "registerSupplementalFieldData" ], "name": "Interface: FieldTypeRegistryApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FieldTypeRegistryApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FieldTypeRegistryEntry.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FieldTypeRegistryEntry.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FieldTypeRegistryEntry", "Properties", "Properties", "artifactId", "category", "fieldTypeId", "supplementalData" ], "headings": [ "Interface: FieldTypeRegistryEntry", "Properties", "Properties", "artifactId", "category", "fieldTypeId", "supplementalData" ], "name": "Interface: FieldTypeRegistryEntry", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FieldTypeRegistryEntry" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_Filter.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_Filter.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: Filter", "Hierarchy", "Properties", "Properties", "global", "hidden", "searchProviderBooleanOperator", "user", "userGlobal", "viewId", "widgetNative" ], "headings": [ "Interface: Filter", "Hierarchy", "Properties", "Properties", "global", "hidden", "searchProviderBooleanOperator", "user", "userGlobal", "viewId", "widgetNative" ], "name": "Interface: Filter", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: Filter" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterBase.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterBase.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FilterBase", "Hierarchy", "Properties", "Properties", "hidden", "user", "userGlobal", "widgetNative" ], "headings": [ "Interface: FilterBase", "Hierarchy", "Properties", "Properties", "hidden", "user", "userGlobal", "widgetNative" ], "name": "Interface: FilterBase", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FilterBase" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterCondition.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterCondition.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FilterCondition", "Properties", "Properties", "displayString", "operation", "value" ], "headings": [ "Interface: FilterCondition", "Properties", "Properties", "displayString", "operation", "value" ], "name": "Interface: FilterCondition", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FilterCondition" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FilterData", "Properties", "Properties", "conditions", "enabled", "field", "fieldDisplayNameOverride", "global", "hidden", "multiple", "pivotOnField", "searchNodeToHide", "userGlobal", "widgetNative", "widgetUuid" ], "headings": [ "Interface: FilterData", "Properties", "Properties", "conditions", "enabled", "field", "fieldDisplayNameOverride", "global", "hidden", "multiple", "pivotOnField", "searchNodeToHide", "userGlobal", "widgetNative", "widgetUuid" ], "name": "Interface: FilterData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FilterData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterInfo.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterInfo.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FilterInfo", "Properties", "Properties", "customData", "data", "type" ], "headings": [ "Interface: FilterInfo", "Properties", "Properties", "customData", "data", "type" ], "name": "Interface: FilterInfo", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FilterInfo" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateModificationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateModificationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FilterStateModificationApi", "Properties", "Properties", "updateFilterState", "v1" ], "headings": [ "Interface: FilterStateModificationApi", "Properties", "Properties", "updateFilterState", "v1" ], "name": "Interface: FilterStateModificationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FilterStateModificationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateModificationApiV1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateModificationApiV1.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FilterStateModificationApiV1", "Properties", "Properties", "updateFilterState" ], "headings": [ "Interface: FilterStateModificationApiV1", "Properties", "Properties", "updateFilterState" ], "name": "Interface: FilterStateModificationApiV1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FilterStateModificationApiV1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateNotificationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateNotificationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FilterStateNotificationApi", "Properties", "Properties", "onFilterStateChange", "v1" ], "headings": [ "Interface: FilterStateNotificationApi", "Properties", "Properties", "onFilterStateChange", "v1" ], "name": "Interface: FilterStateNotificationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FilterStateNotificationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateNotificationApiV1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_FilterStateNotificationApiV1.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FilterStateNotificationApiV1", "Properties", "Properties", "onFilterStateChange" ], "headings": [ "Interface: FilterStateNotificationApiV1", "Properties", "Properties", "onFilterStateChange" ], "name": "Interface: FilterStateNotificationApiV1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FilterStateNotificationApiV1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_InteractionApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_InteractionApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: InteractionApi", "Properties", "Properties", "config", "customCondition", "dashboard", "dataSource", "fieldTypeRegistry", "filterStateModification", "filterStateNotification", "frameContentHelperApi", "itemList", "modal", "objectManager", "outboundTranslation", "pageInfo", "panel", "relativityUrlApi", "sampleStateModification", "sampleStateNotification", "toastNotification", "toolbar", "widget" ], "headings": [ "Interface: InteractionApi", "Properties", "Properties", "config", "customCondition", "dashboard", "dataSource", "fieldTypeRegistry", "filterStateModification", "filterStateNotification", "frameContentHelperApi", "itemList", "modal", "objectManager", "outboundTranslation", "pageInfo", "panel", "relativityUrlApi", "sampleStateModification", "sampleStateNotification", "toastNotification", "toolbar", "widget" ], "name": "Interface: InteractionApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: InteractionApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ItemListApi", "Properties", "Properties", "getSelectedKeys", "onBrowserChange", "onDashboardChange", "onHighlightedRowChange", "onItemListPopulated", "onSelectedCountChange", "onTotalCountChange", "onViewChange", "requestItemListDataReload" ], "headings": [ "Interface: ItemListApi", "Properties", "Properties", "getSelectedKeys", "onBrowserChange", "onDashboardChange", "onHighlightedRowChange", "onItemListPopulated", "onSelectedCountChange", "onTotalCountChange", "onViewChange", "requestItemListDataReload" ], "name": "Interface: ItemListApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ItemListApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ItemListData", "Properties", "Properties", "IDWindow", "data", "startIndex", "totalCount" ], "headings": [ "Interface: ItemListData", "Properties", "Properties", "IDWindow", "data", "startIndex", "totalCount" ], "name": "Interface: ItemListData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ItemListData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListDataSource.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListDataSource.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ItemListDataSource", "Methods", "Methods", "getData", "transformInbound", "transformMultiReflectedFields" ], "headings": [ "Interface: ItemListDataSource", "Methods", "Methods", "getData", "transformInbound", "transformMultiReflectedFields" ], "name": "Interface: ItemListDataSource", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ItemListDataSource" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListDataSourceCallbacks.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListDataSourceCallbacks.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ItemListDataSourceCallbacks", "Methods", "Methods", "setItemListListRowKey" ], "headings": [ "Interface: ItemListDataSourceCallbacks", "Methods", "Methods", "setItemListListRowKey" ], "name": "Interface: ItemListDataSourceCallbacks", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ItemListDataSourceCallbacks" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListFieldCollection.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListFieldCollection.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ItemListFieldCollection", "Indexable" ], "headings": [ "Interface: ItemListFieldCollection", "Indexable" ], "name": "Interface: ItemListFieldCollection", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ItemListFieldCollection" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListFieldRef.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ItemListFieldRef.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ItemListFieldRef", "Hierarchy", "Properties", "Properties", "AllowGroupBy", "AllowHtml", "AllowPivot", "ArtifactID", "AssociativeObjectTypeID", "AvfID", "Category", "ColumnName", "ConnectorFieldArtifactID", "DataGridEnabled", "DisplayName", "FalseValue", "FieldTreeView", "FieldTypeID", "FilterType", "FormatString", "FriendlyName", "Guid", "Guids", "HeaderName", "IncludeInTextIndex", "IsFilterable", "IsLinked", "IsReflected", "IsRelational", "IsSortable", "IsSystem", "IsVisible", "ItemListType", "MaxLength", "Name", "PopupPickerView", "SourceFieldArtifactGuids", "StaticText", "TrueValue", "ViewFieldID", "Width", "Wrapping", "artifactID", "name" ], "headings": [ "Interface: ItemListFieldRef", "Hierarchy", "Properties", "Properties", "AllowGroupBy", "AllowHtml", "AllowPivot", "ArtifactID", "AssociativeObjectTypeID", "AvfID", "Category", "ColumnName", "ConnectorFieldArtifactID", "DataGridEnabled", "DisplayName", "FalseValue", "FieldTreeView", "FieldTypeID", "FilterType", "FormatString", "FriendlyName", "Guid", "Guids", "HeaderName", "IncludeInTextIndex", "IsFilterable", "IsLinked", "IsReflected", "IsRelational", "IsSortable", "IsSystem", "IsVisible", "ItemListType", "MaxLength", "Name", "PopupPickerView", "SourceFieldArtifactGuids", "StaticText", "TrueValue", "ViewFieldID", "Width", "Wrapping", "artifactID", "name" ], "name": "Interface: ItemListFieldRef", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ItemListFieldRef" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_MenuApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_MenuApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: MenuApi", "Properties", "Properties", "menu", "typeName" ], "headings": [ "Interface: MenuApi", "Properties", "Properties", "menu", "typeName" ], "name": "Interface: MenuApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: MenuApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ModalAction.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ModalAction.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ModalAction", "Properties", "Properties", "callback", "destructive", "disable", "label", "loading", "secondary", "tertiary" ], "headings": [ "Interface: ModalAction", "Properties", "Properties", "callback", "destructive", "disable", "label", "loading", "secondary", "tertiary" ], "name": "Interface: ModalAction", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ModalAction" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ModalApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ModalApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ModalApi", "Properties", "Properties", "confirm", "openCustomModal", "openExternalModal" ], "headings": [ "Interface: ModalApi", "Properties", "Properties", "confirm", "openCustomModal", "openExternalModal" ], "name": "Interface: ModalApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ModalApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ObjectManagerApi", "Methods", "Methods", "getCurrentStateQueryRequest" ], "headings": [ "Interface: ObjectManagerApi", "Methods", "Methods", "getCurrentStateQueryRequest" ], "name": "Interface: ObjectManagerApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ObjectManagerApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ObjectManagerData", "Properties", "Properties", "CurrentStartIndex", "Fields", "IDWindow", "ObjectType", "Objects", "ResultCount", "SampleDetails", "TotalCount", "extendedData" ], "headings": [ "Interface: ObjectManagerData", "Properties", "Properties", "CurrentStartIndex", "Fields", "IDWindow", "ObjectType", "Objects", "ResultCount", "SampleDetails", "TotalCount", "extendedData" ], "name": "Interface: ObjectManagerData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ObjectManagerData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerObject.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerObject.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ObjectManagerObject", "Properties", "Properties", "ArtifactID", "Values" ], "headings": [ "Interface: ObjectManagerObject", "Properties", "Properties", "ArtifactID", "Values" ], "name": "Interface: ObjectManagerObject", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ObjectManagerObject" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerReadRequest.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerReadRequest.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ObjectManagerReadRequest", "Properties", "Properties", "Fields", "object" ], "headings": [ "Interface: ObjectManagerReadRequest", "Properties", "Properties", "Fields", "object" ], "name": "Interface: ObjectManagerReadRequest", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ObjectManagerReadRequest" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerReadResponse.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerReadResponse.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ObjectManagerReadResponse", "Properties", "Properties", "FieldValues", "ObjectVersionToken", "object" ], "headings": [ "Interface: ObjectManagerReadResponse", "Properties", "Properties", "FieldValues", "ObjectVersionToken", "object" ], "name": "Interface: ObjectManagerReadResponse", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ObjectManagerReadResponse" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerRequest.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerRequest.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ObjectManagerRequest", "Properties", "Properties", "activeArtifactId", "cancellable", "condition", "convertNumberFieldValuesToString", "executingSavedSearchId", "executingViewId", "fields", "includeIdWindow", "isAdHocQuery", "longTextBehavior", "objectType", "queryHint", "rankSortOrder", "relationalField", "rowCondition", "sampleParameters", "searchProviderCondition", "sorts" ], "headings": [ "Interface: ObjectManagerRequest", "Properties", "Properties", "activeArtifactId", "cancellable", "condition", "convertNumberFieldValuesToString", "executingSavedSearchId", "executingViewId", "fields", "includeIdWindow", "isAdHocQuery", "longTextBehavior", "objectType", "queryHint", "rankSortOrder", "relationalField", "rowCondition", "sampleParameters", "searchProviderCondition", "sorts" ], "name": "Interface: ObjectManagerRequest", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ObjectManagerRequest" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerSort.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerSort.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ObjectManagerSort", "Properties", "Properties", "Direction", "FieldIdentifier" ], "headings": [ "Interface: ObjectManagerSort", "Properties", "Properties", "Direction", "FieldIdentifier" ], "name": "Interface: ObjectManagerSort", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ObjectManagerSort" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerUpdateRequest.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerUpdateRequest.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ObjectManagerUpdateRequest", "Properties", "Properties", "FieldValues", "ObjectVersionToken", "object" ], "headings": [ "Interface: ObjectManagerUpdateRequest", "Properties", "Properties", "FieldValues", "ObjectVersionToken", "object" ], "name": "Interface: ObjectManagerUpdateRequest", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ObjectManagerUpdateRequest" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerUpdateResponse.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectManagerUpdateResponse.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ObjectManagerUpdateResponse", "Properties", "Properties", "EventHandlerStatuses" ], "headings": [ "Interface: ObjectManagerUpdateResponse", "Properties", "Properties", "EventHandlerStatuses" ], "name": "Interface: ObjectManagerUpdateResponse", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ObjectManagerUpdateResponse" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ObjectType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ObjectType", "Properties", "Properties", "ArtifactID", "ArtifactTypeID", "Guids", "Name" ], "headings": [ "Interface: ObjectType", "Properties", "Properties", "ArtifactID", "ArtifactTypeID", "Guids", "Name" ], "name": "Interface: ObjectType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ObjectType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_OutboundTranslationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_OutboundTranslationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: OutboundTranslationApi", "Properties", "Properties", "translateFilterTreeToQueryConditions", "translateItemListFiltersToObjectManagerCondition", "translateSearchFiltersAndViewToObjectManagerCondition", "translateSortsToSortConditions", "v1" ], "headings": [ "Interface: OutboundTranslationApi", "Properties", "Properties", "translateFilterTreeToQueryConditions", "translateItemListFiltersToObjectManagerCondition", "translateSearchFiltersAndViewToObjectManagerCondition", "translateSortsToSortConditions", "v1" ], "name": "Interface: OutboundTranslationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: OutboundTranslationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_OutboundTranslationApiV1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_OutboundTranslationApiV1.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: OutboundTranslationApiV1", "Properties", "Properties", "translateFilterTreeToQueryConditions", "translateSortsToSortConditions" ], "headings": [ "Interface: OutboundTranslationApiV1", "Properties", "Properties", "translateFilterTreeToQueryConditions", "translateSortsToSortConditions" ], "name": "Interface: OutboundTranslationApiV1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: OutboundTranslationApiV1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PageInfoApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PageInfoApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: PageInfoApi", "Properties", "Properties", "getFilters", "getRelationalField", "getSampleState", "getSorts", "v1" ], "headings": [ "Interface: PageInfoApi", "Properties", "Properties", "getFilters", "getRelationalField", "getSampleState", "getSorts", "v1" ], "name": "Interface: PageInfoApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: PageInfoApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PageInfoApiV1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PageInfoApiV1.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: PageInfoApiV1", "Properties", "Properties", "getActiveSearchInfo", "getCurrentBrowser", "getFilters", "getRelationalField", "getSampleState", "getSorts", "onRelationalFieldChange" ], "headings": [ "Interface: PageInfoApiV1", "Properties", "Properties", "getActiveSearchInfo", "getCurrentBrowser", "getFilters", "getRelationalField", "getSampleState", "getSorts", "onRelationalFieldChange" ], "name": "Interface: PageInfoApiV1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: PageInfoApiV1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PanelApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PanelApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: PanelApi", "Properties", "Properties", "collapsePanels", "createComponentPanel", "createExternalPanel", "expandPanels", "hidePanels", "showPanels", "updateExternalPanel" ], "headings": [ "Interface: PanelApi", "Properties", "Properties", "collapsePanels", "createComponentPanel", "createExternalPanel", "expandPanels", "hidePanels", "showPanels", "updateExternalPanel" ], "name": "Interface: PanelApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: PanelApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PivotOnCondition.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_PivotOnCondition.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: PivotOnCondition", "Properties", "Properties", "operation", "value" ], "headings": [ "Interface: PivotOnCondition", "Properties", "Properties", "operation", "value" ], "name": "Interface: PivotOnCondition", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: PivotOnCondition" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_QueryTranslationResponse.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_QueryTranslationResponse.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: QueryTranslationResponse", "Properties", "Properties", "conditionFilter", "rowFilter", "searchProviderFilter" ], "headings": [ "Interface: QueryTranslationResponse", "Properties", "Properties", "conditionFilter", "rowFilter", "searchProviderFilter" ], "name": "Interface: QueryTranslationResponse", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: QueryTranslationResponse" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_RelativityHttpClient.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_RelativityHttpClient.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: RelativityHttpClient", "Properties", "Properties", "delete", "get", "getCancellationToken", "keplerCallLRP", "keplerDelete", "keplerGet", "keplerPatch", "keplerPost", "keplerPut", "makeRelativityBaseRequestOptions", "makeRelativityRelativeUrl", "makeRelativityRestBaseRequestOptions", "makeRelativityRestRelativeUrl", "patch", "post", "put" ], "headings": [ "Interface: RelativityHttpClient", "Properties", "Properties", "delete", "get", "getCancellationToken", "keplerCallLRP", "keplerDelete", "keplerGet", "keplerPatch", "keplerPost", "keplerPut", "makeRelativityBaseRequestOptions", "makeRelativityRelativeUrl", "makeRelativityRestBaseRequestOptions", "makeRelativityRestRelativeUrl", "patch", "post", "put" ], "name": "Interface: RelativityHttpClient", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: RelativityHttpClient" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleDetails.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleDetails.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: SampleDetails", "Properties", "Properties", "SampleSize", "Token", "UniverseSize" ], "headings": [ "Interface: SampleDetails", "Properties", "Properties", "SampleSize", "Token", "UniverseSize" ], "name": "Interface: SampleDetails", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: SampleDetails" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleExistingToken.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleExistingToken.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: SampleExistingToken", "Properties", "Properties", "existingToken" ], "headings": [ "Interface: SampleExistingToken", "Properties", "Properties", "existingToken" ], "name": "Interface: SampleExistingToken", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: SampleExistingToken" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleParameters.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleParameters.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: SampleParameters", "Properties", "Properties", "browserNodeID", "confidenceLevel", "fixedSampleSize", "marginOfError", "samplingPercentage" ], "headings": [ "Interface: SampleParameters", "Properties", "Properties", "browserNodeID", "confidenceLevel", "fixedSampleSize", "marginOfError", "samplingPercentage" ], "name": "Interface: SampleParameters", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: SampleParameters" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleStateModificationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleStateModificationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: SampleStateModificationApi", "Properties", "Properties", "updateSampleState" ], "headings": [ "Interface: SampleStateModificationApi", "Properties", "Properties", "updateSampleState" ], "name": "Interface: SampleStateModificationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: SampleStateModificationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleStateNotificationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SampleStateNotificationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: SampleStateNotificationApi", "Properties", "Properties", "onSampleStateChange" ], "headings": [ "Interface: SampleStateNotificationApi", "Properties", "Properties", "onSampleStateChange" ], "name": "Interface: SampleStateNotificationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: SampleStateNotificationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SearchIndex.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SearchIndex.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: SearchIndex", "Properties", "Properties", "ArtifactID" ], "headings": [ "Interface: SearchIndex", "Properties", "Properties", "ArtifactID" ], "name": "Interface: SearchIndex", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: SearchIndex" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SearchProviderCondition.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SearchProviderCondition.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: SearchProviderCondition", "Properties", "Properties", "input", "isUnionSearch", "searchIndex" ], "headings": [ "Interface: SearchProviderCondition", "Properties", "Properties", "input", "isUnionSearch", "searchIndex" ], "name": "Interface: SearchProviderCondition", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: SearchProviderCondition" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SearchProviderCondition_1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SearchProviderCondition_1.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: SearchProviderCondition", "Properties", "Properties", "artifactId", "input", "searchProviderBooleanOperator" ], "headings": [ "Interface: SearchProviderCondition", "Properties", "Properties", "artifactId", "input", "searchProviderBooleanOperator" ], "name": "Interface: SearchProviderCondition", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: SearchProviderCondition" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SortMetadata.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_SortMetadata.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: SortMetadata", "Properties", "Properties", "Direction", "FieldIdentifier", "Order" ], "headings": [ "Interface: SortMetadata", "Properties", "Properties", "Direction", "FieldIdentifier", "Order" ], "name": "Interface: SortMetadata", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: SortMetadata" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToastNotificationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToastNotificationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ToastNotificationApi", "Properties", "Properties", "createAndShowErrorToast", "createAndShowInformationToast", "createAndShowSuccessToast", "createAndShowWarningToast", "createToast", "hideToast", "showToast" ], "headings": [ "Interface: ToastNotificationApi", "Properties", "Properties", "createAndShowErrorToast", "createAndShowInformationToast", "createAndShowSuccessToast", "createAndShowWarningToast", "createToast", "hideToast", "showToast" ], "name": "Interface: ToastNotificationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ToastNotificationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ToolbarApi", "Properties", "Properties", "createToolbarContent", "hideToolbar", "modifyToolbarContent", "showToolbar", "v1" ], "headings": [ "Interface: ToolbarApi", "Properties", "Properties", "createToolbarContent", "hideToolbar", "modifyToolbarContent", "showToolbar", "v1" ], "name": "Interface: ToolbarApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ToolbarApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarApiV1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarApiV1.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ToolbarApiV1", "Properties", "Properties", "createToolbarContent", "getToolbarState", "hideAllToolbars", "hideToolbar", "modifyToolbarContent", "showAllToolbars", "showToolbar" ], "headings": [ "Interface: ToolbarApiV1", "Properties", "Properties", "createToolbarContent", "getToolbarState", "hideAllToolbars", "hideToolbar", "modifyToolbarContent", "showAllToolbars", "showToolbar" ], "name": "Interface: ToolbarApiV1", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ToolbarApiV1" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarContent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarContent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ToolbarContent", "Properties", "Properties", "center", "cssClass", "dominantSlot", "left", "right", "useRawElements" ], "headings": [ "Interface: ToolbarContent", "Properties", "Properties", "center", "cssClass", "dominantSlot", "left", "right", "useRawElements" ], "name": "Interface: ToolbarContent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ToolbarContent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarFactory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarFactory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ToolbarFactory", "Callable", "ToolbarFactory" ], "headings": [ "Interface: ToolbarFactory", "Callable", "ToolbarFactory" ], "name": "Interface: ToolbarFactory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ToolbarFactory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarStateItem.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_ToolbarStateItem.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ToolbarStateItem", "Properties", "Properties", "cssClass", "hidden", "id" ], "headings": [ "Interface: ToolbarStateItem", "Properties", "Properties", "cssClass", "hidden", "id" ], "name": "Interface: ToolbarStateItem", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ToolbarStateItem" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_UtilitiesApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_UtilitiesApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: UtilitiesApi", "Properties", "Properties", "sanitize" ], "headings": [ "Interface: UtilitiesApi", "Properties", "Properties", "sanitize" ], "name": "Interface: UtilitiesApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: UtilitiesApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_View.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_View.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: View", "Properties", "Properties", "AllConditionCount", "ArtifactId", "DashboardArtifactId", "FieldsIds", "GroupDefinitionFieldName", "HasConditions", "InlineEditingEnabled", "Name", "QueryHint", "RenderLinks", "SavedSearchConditionCount", "Sorts" ], "headings": [ "Interface: View", "Properties", "Properties", "AllConditionCount", "ArtifactId", "DashboardArtifactId", "FieldsIds", "GroupDefinitionFieldName", "HasConditions", "InlineEditingEnabled", "Name", "QueryHint", "RenderLinks", "SavedSearchConditionCount", "Sorts" ], "name": "Interface: View", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: View" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: WidgetApi", "Properties", "Properties", "addOrUpdateWidget", "deleteWidget", "getWidgetIDs", "onWidgetDelete", "onWidgetMenuCreate", "registerWidgetType" ], "headings": [ "Interface: WidgetApi", "Properties", "Properties", "addOrUpdateWidget", "deleteWidget", "getWidgetIDs", "onWidgetDelete", "onWidgetMenuCreate", "registerWidgetType" ], "name": "Interface: WidgetApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: WidgetApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetDeleteEventHandler.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetDeleteEventHandler.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: WidgetDeleteEventHandler", "Callable", "WidgetDeleteEventHandler" ], "headings": [ "Interface: WidgetDeleteEventHandler", "Callable", "WidgetDeleteEventHandler" ], "name": "Interface: WidgetDeleteEventHandler", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: WidgetDeleteEventHandler" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetFactory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetFactory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: WidgetFactory", "Callable", "WidgetFactory" ], "headings": [ "Interface: WidgetFactory", "Callable", "WidgetFactory" ], "name": "Interface: WidgetFactory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: WidgetFactory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetInstance.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetInstance.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: WidgetInstance", "Properties", "Properties", "menu", "title", "wgtRef" ], "headings": [ "Interface: WidgetInstance", "Properties", "Properties", "menu", "title", "wgtRef" ], "name": "Interface: WidgetInstance", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: WidgetInstance" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetItem.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetItem.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: WidgetItem", "Properties", "Properties", "icon", "name", "onClick", "type", "value", "visible" ], "headings": [ "Interface: WidgetItem", "Properties", "Properties", "icon", "name", "onClick", "type", "value", "visible" ], "name": "Interface: WidgetItem", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: WidgetItem" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetMenu.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetMenu.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: WidgetMenu", "Properties", "Properties", "items", "title", "visible" ], "headings": [ "Interface: WidgetMenu", "Properties", "Properties", "items", "title", "visible" ], "name": "Interface: WidgetMenu", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: WidgetMenu" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetMenuEventHandler.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetMenuEventHandler.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: WidgetMenuEventHandler", "Callable", "WidgetMenuEventHandler" ], "headings": [ "Interface: WidgetMenuEventHandler", "Callable", "WidgetMenuEventHandler" ], "name": "Interface: WidgetMenuEventHandler", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: WidgetMenuEventHandler" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetStateInfo.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetStateInfo.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: WidgetStateInfo", "Indexable", "Properties", "Properties", "height_px", "settings", "type", "width_pct" ], "headings": [ "Interface: WidgetStateInfo", "Indexable", "Properties", "Properties", "height_px", "settings", "type", "width_pct" ], "name": "Interface: WidgetStateInfo", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: WidgetStateInfo" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetStateSettings.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Interface_WidgetStateSettings.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: WidgetStateSettings", "Indexable", "Properties", "Properties", "id", "title" ], "headings": [ "Interface: WidgetStateSettings", "Indexable", "Properties", "Properties", "id", "title" ], "name": "Interface: WidgetStateSettings", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: WidgetStateSettings" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Classes.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Classes.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Lists Interaction API Classes", "headings": "Lists Interaction API Classes", "name": "Lists Interaction API Classes", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Lists Interaction API Classes" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Enums.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Enums.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Lists Interaction API Enums", "headings": "Lists Interaction API Enums", "name": "Lists Interaction API Enums", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Lists Interaction API Enums" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Interfaces.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Interfaces.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Lists Interaction API Interfaces", "headings": "Lists Interaction API Interfaces", "name": "Lists Interaction API Interfaces", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Lists Interaction API Interfaces" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Modules.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Lists_Interaction_API_Modules.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Lists Interaction API Modules", "headings": "Lists Interaction API Modules", "name": "Lists Interaction API Modules", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Lists Interaction API Modules" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_Browser.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_Browser.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: Browser", "Enumerations", "Interfaces", "Type Aliases", "Type Aliases", "BrowserStateMap" ], "headings": [ "Module: Browser", "Enumerations", "Interfaces", "Type Aliases", "Type Aliases", "BrowserStateMap" ], "name": "Module: Browser", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: Browser" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ConfigApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ConfigApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: ConfigApi", "Interfaces", "Type Aliases", "Type Aliases", "EventHandlerFunction" ], "headings": [ "Module: ConfigApi", "Interfaces", "Type Aliases", "Type Aliases", "EventHandlerFunction" ], "name": "Module: ConfigApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: ConfigApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ConvenienceApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ConvenienceApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: ConvenienceApi", "Interfaces" ], "headings": [ "Module: ConvenienceApi", "Interfaces" ], "name": "Module: ConvenienceApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: ConvenienceApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_CustomConditionApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_CustomConditionApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: CustomConditionApi", "Enumerations", "Interfaces", "Type Aliases", "Type Aliases", "CustomConditionCallback" ], "headings": [ "Module: CustomConditionApi", "Enumerations", "Interfaces", "Type Aliases", "Type Aliases", "CustomConditionCallback" ], "name": "Module: CustomConditionApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: CustomConditionApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_DashboardApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_DashboardApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: DashboardApi", "Interfaces" ], "headings": [ "Module: DashboardApi", "Interfaces" ], "name": "Module: DashboardApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: DashboardApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_DataSourceApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_DataSourceApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: DataSourceApi", "Enumerations", "Interfaces", "Type Aliases", "Type Aliases", "ArtifactIdentifier", "CustomFormatterOptions", "DataSource", "FieldValue", "FormatterDataItem", "ItemListDataSourceFactoryFunction", "SetListFilterDataFunction" ], "headings": [ "Module: DataSourceApi", "Enumerations", "Interfaces", "Type Aliases", "Type Aliases", "ArtifactIdentifier", "CustomFormatterOptions", "DataSource", "FieldValue", "FormatterDataItem", "ItemListDataSourceFactoryFunction", "SetListFilterDataFunction" ], "name": "Module: DataSourceApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: DataSourceApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FieldRef.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FieldRef.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: FieldRef", "Interfaces" ], "headings": [ "Module: FieldRef", "Interfaces" ], "name": "Module: FieldRef", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: FieldRef" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FieldTypeRegistryApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FieldTypeRegistryApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: FieldTypeRegistryApi", "Interfaces" ], "headings": [ "Module: FieldTypeRegistryApi", "Interfaces" ], "name": "Module: FieldTypeRegistryApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: FieldTypeRegistryApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_Filter.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_Filter.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: Filter", "Enumerations", "Classes", "Interfaces" ], "headings": [ "Module: Filter", "Enumerations", "Classes", "Interfaces" ], "name": "Module: Filter", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: Filter" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FilterStateModificationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FilterStateModificationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: FilterStateModificationApi", "Enumerations", "Interfaces" ], "headings": [ "Module: FilterStateModificationApi", "Enumerations", "Interfaces" ], "name": "Module: FilterStateModificationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: FilterStateModificationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FilterStateNotificationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_FilterStateNotificationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: FilterStateNotificationApi", "Interfaces", "Type Aliases", "Type Aliases", "FilterStateChangeFunction", "FilterStateChangeFunctionV1" ], "headings": [ "Module: FilterStateNotificationApi", "Interfaces", "Type Aliases", "Type Aliases", "FilterStateChangeFunction", "FilterStateChangeFunctionV1" ], "name": "Module: FilterStateNotificationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: FilterStateNotificationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_InteractionApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_InteractionApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: InteractionApi", "Interfaces" ], "headings": [ "Module: InteractionApi", "Interfaces" ], "name": "Module: InteractionApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: InteractionApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ItemListApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ItemListApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: ItemListApi", "Interfaces" ], "headings": [ "Module: ItemListApi", "Interfaces" ], "name": "Module: ItemListApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: ItemListApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ModalApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ModalApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: ModalApi", "Interfaces", "Type Aliases", "Type Aliases", "OpenModalHandler", "RWCModalSize" ], "headings": [ "Module: ModalApi", "Interfaces", "Type Aliases", "Type Aliases", "OpenModalHandler", "RWCModalSize" ], "name": "Module: ModalApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: ModalApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ObjectManagerApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ObjectManagerApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: ObjectManagerApi", "Enumerations", "Interfaces" ], "headings": [ "Module: ObjectManagerApi", "Enumerations", "Interfaces" ], "name": "Module: ObjectManagerApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: ObjectManagerApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_OutboundTranslationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_OutboundTranslationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: OutboundTranslationApi", "Interfaces" ], "headings": [ "Module: OutboundTranslationApi", "Interfaces" ], "name": "Module: OutboundTranslationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: OutboundTranslationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_PageInfoApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_PageInfoApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: PageInfoApi", "Interfaces" ], "headings": [ "Module: PageInfoApi", "Interfaces" ], "name": "Module: PageInfoApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: PageInfoApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_PanelApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_PanelApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: PanelApi", "Interfaces" ], "headings": [ "Module: PanelApi", "Interfaces" ], "name": "Module: PanelApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: PanelApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_SampleStateModificationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_SampleStateModificationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: SampleStateModificationApi", "Interfaces" ], "headings": [ "Module: SampleStateModificationApi", "Interfaces" ], "name": "Module: SampleStateModificationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: SampleStateModificationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_SampleStateNotificationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_SampleStateNotificationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: SampleStateNotificationApi", "Classes", "Interfaces", "Type Aliases", "Type Aliases", "SampleDetailsMap", "SampleParametersMap", "SampleStateChangeFunction" ], "headings": [ "Module: SampleStateNotificationApi", "Classes", "Interfaces", "Type Aliases", "Type Aliases", "SampleDetailsMap", "SampleParametersMap", "SampleStateChangeFunction" ], "name": "Module: SampleStateNotificationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: SampleStateNotificationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ToastNotificationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ToastNotificationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: ToastNotificationApi", "Interfaces" ], "headings": [ "Module: ToastNotificationApi", "Interfaces" ], "name": "Module: ToastNotificationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: ToastNotificationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ToolbarApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_ToolbarApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: ToolbarApi", "Enumerations", "Interfaces", "Type Aliases", "Type Aliases", "ToolbarSlotName" ], "headings": [ "Module: ToolbarApi", "Enumerations", "Interfaces", "Type Aliases", "Type Aliases", "ToolbarSlotName" ], "name": "Module: ToolbarApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: ToolbarApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_View.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_View.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: View", "Interfaces" ], "headings": [ "Module: View", "Interfaces" ], "name": "Module: View", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: View" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_WidgetApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Module_WidgetApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Module: WidgetApi", "Interfaces" ], "headings": [ "Module: WidgetApi", "Interfaces" ], "name": "Module: WidgetApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Module: WidgetApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Relativity_Lists_Interaction.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Relativity_Lists_Interaction.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Lists Interaction API", "Modules" ], "headings": [ "Relativity Lists Interaction API", "Modules" ], "name": "Relativity Lists Interaction API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Relativity Lists Interaction API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Relativity_Lists_Interaction_APIs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Lists_Interaction_API/Relativity_Lists_Interaction_APIs.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Lists Interaction APIs", "Summary", "Interaction Script Format", "Example Interaction Script", "Execution Context", "Associating With An Object Type", "Migrating a Classic List Page Interaction Script to Relativity.Lists", "Testing A Migrated Interaction Script", "Initializer API", "Event-based APIs", "General service APIs", "Common Migration Scenarios", "Script Caching", "Modules" ], "headings": [ "Relativity Lists Interaction APIs", "Summary", "Interaction Script Format", "Example Interaction Script", "Execution Context", "Associating With An Object Type", "Migrating a Classic List Page Interaction Script to Relativity.Lists", "Testing A Migrated Interaction Script", "Initializer API", "Event-based APIs", "General service APIs", "Common Migration Scenarios", "Script Caching", "Modules" ], "name": "Relativity Lists Interaction APIs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Relativity Lists Interaction APIs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Logging/External_Logging.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Logging/External_Logging.htm" }, "description": "Using an external, third-party logging provider to log from a custom Relativity application", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Using External Logging", "Prerequisites", "Scope", "Data Security", "Logging Instance Settings", "Logging Packages", "Logging", "Troubleshooting" ], "headings": [ "Using External Logging", "Prerequisites", "Scope", "Data Security", "Logging Instance Settings", "Logging Packages", "Logging", "Troubleshooting" ], "name": "External Logging", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Using an external, third-party logging provider to log from a custom Relativity application", "title": "External Logging" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Logging/IAPILog_Interface_Logging.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Logging/IAPILog_Interface_Logging.htm" }, "description": "Using the IAPILog Interface for logging from a custom Relativity application", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Using the IAPILog Interface for logging", "Before you begin", "IAPILog interface", "Add loggers using API\u0026#160;helpers", "Add custom metadata to loggers", "Best practices" ], "headings": [ "Using the IAPILog Interface for logging", "Before you begin", "IAPILog interface", "Add loggers using API\u0026#160;helpers", "Add custom metadata to loggers", "Best practices" ], "name": "Using the IAPILog Interface for logging", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Using the IAPILog Interface for logging from a custom Relativity application", "title": "Using the IAPILog Interface for logging" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Logging/Log_from_a_Relativity_application.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Logging/Log_from_a_Relativity_application.htm" }, "description": "Writing log output from your custom applications", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Logging from Relativity applications", "Data Logging Security" ], "headings": [ "Logging from Relativity applications", "Data Logging Security" ], "name": "Logging from Relativity applications", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Writing log output from your custom applications", "title": "Logging from Relativity applications" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Building_Media_Tracker_with_RDOs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Building_Media_Tracker_with_RDOs.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Building Media Tracker with Relativity Dynamic Objects", "Create a new application", "Link and create object types", "Update and create fields", "Update views", "Build layouts", "Export Media Tracker application" ], "headings": [ "Building Media Tracker with Relativity Dynamic Objects", "Create a new application", "Link and create object types", "Update and create fields", "Update views", "Build layouts", "Export Media Tracker application" ], "name": "Building Media Tracker with Relativity Dynamic Objects", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Building Media Tracker with Relativity Dynamic Objects" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Creating_a_question_object.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Creating_a_question_object.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Creating a question object", "Creating the Question object type", "Editing field and layout views", "Editing the Fields view", "Editing the Layouts view", "Filtering to view Question types", "Creating the Question object fields", "Creating the Question field", "Creating the Answer field", "Creating a multiple object field", "Writing questions and modifying the Question tab", "Adding new questions", "Adding an Answer to the Question detail page", "Adding the Documents list to the Question detail page", "Adding Answers to the Question tab", "Adding questions to a layout in the viewer", "Setting up Question-related views", "Creating a Document view for documents with questions", "Creating a Document view for documents with no questions", "Linking questions to a document during review" ], "headings": [ "Creating a question object", "Creating the Question object type", "Editing field and layout views", "Editing the Fields view", "Editing the Layouts view", "Filtering to view Question types", "Creating the Question object fields", "Creating the Question field", "Creating the Answer field", "Creating a multiple object field", "Writing questions and modifying the Question tab", "Adding new questions", "Adding an Answer to the Question detail page", "Adding the Documents list to the Question detail page", "Adding Answers to the Question tab", "Adding questions to a layout in the viewer", "Setting up Question-related views", "Creating a Document view for documents with questions", "Creating a Document view for documents with no questions", "Linking questions to a document during review" ], "name": "Creating a question object", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Creating a question object" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Creating_a_tab_to_bookmark_an_object.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Creating_a_tab_to_bookmark_an_object.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Creating a tab to bookmark an object", "Finding the ArtifactID", "Creating the tab" ], "headings": [ "Creating a tab to bookmark an object", "Finding the ArtifactID", "Creating the tab" ], "name": "Creating a tab to bookmark an object", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Creating a tab to bookmark an object" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Creating_and_editing_Relativity_Objects.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Creating_and_editing_Relativity_Objects.htm" }, "description": "RDOs are object types that you create and manage from within any Relativity application.\u0026#160;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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Creating and editing Relativity Objects", "Permissions", "Creating an object from a workspace", "Creating an object from home", "Deleting an object from a workspace", "Deleting an object from home", "Editing an object\u0027s details", "Fields for an object type", "Object Type Information section", "Object Type Settings section", "Other section", "Adding an event handler", "Deleting an event handler", "Adding an object rule", "Default Layout", "Custom Single Object\u0026#160;Add Link Visibility", "Default Layout on New", "Global Button Visibility", "Mass Action Visibility", "Choice Behavior", "Sub-List Button Visibility", "New Button Override", "Override edit link URL", "Override view link URL", "Adding a custom mass operation", "Mass operation fields", "Adding information to objects" ], "headings": [ "Creating and editing Relativity Objects", "Permissions", "Creating an object from a workspace", "Creating an object from home", "Deleting an object from a workspace", "Deleting an object from home", "Editing an object\u0027s details", "Fields for an object type", "Object Type Information section", "Object Type Settings section", "Other section", "Adding an event handler", "Deleting an event handler", "Adding an object rule", "Default Layout", "Custom Single Object\u0026#160;Add Link Visibility", "Default Layout on New", "Global Button Visibility", "Mass Action Visibility", "Choice Behavior", "Sub-List Button Visibility", "New Button Override", "Override edit link URL", "Override view link URL", "Adding a custom mass operation", "Mass operation fields", "Adding information to objects" ], "name": "Creating and editing Relativity Objects", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "RDOs are object types that you create and manage from within any Relativity application.\u0026#160;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.", "title": "Creating and editing Relativity Objects" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Deleting_object_dependencies.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Deleting_object_dependencies.htm" }, "description": "Deleting object dependencies removes that object\u0027s interactions, or dependencies, from other objects. Because the purpose of objects is to interact with other objects, there may be a certain amount of dependencies. Most are created at the time the object is initially instantiated, although you can add some later, either implicitly as a result of a workflow, or manually adding one, such as an event handler. However, deleting some dependencies may have unexpected effects on other objects. To mitigate those effects, Relativity may display a dependencies report, and asks you to confirm before deleting.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Deleting object dependencies", "Force deleting object dependencies", "Displaying and interpreting the dependencies report", "Considering the fields of force deleted objects", "Analytics categorization set example", "Search terms reports example" ], "headings": [ "Deleting object dependencies", "Force deleting object dependencies", "Displaying and interpreting the dependencies report", "Considering the fields of force deleted objects", "Analytics categorization set example", "Search terms reports example" ], "name": "Deleting object dependencies", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Deleting object dependencies removes that object\u0027s interactions, or dependencies, from other objects. Because the purpose of objects is to interact with other objects, there may be a certain amount of dependencies. Most are created at the time the object is initially instantiated, although you can add some later, either implicitly as a result of a workflow, or manually adding one, such as an event handler. However, deleting some dependencies may have unexpected effects on other objects. To mitigate those effects, Relativity may display a dependencies report, and asks you to confirm before deleting.", "title": "Deleting object dependencies" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Relativity_objects.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Managing_Relativity_dynamic_objects/RDO/Relativity_objects.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Objects", "System objects", "Relativity Dynamic Objects (RDOs)", "Programmatically using Relativity objects and RDOs" ], "headings": [ "Relativity Objects", "System objects", "Relativity Dynamic Objects (RDOs)", "Programmatically using Relativity objects and RDOs" ], "name": "Relativity Objects", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity Objects" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Publish_to_Relativity_Tool/Publish_to_Relativity_tool.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Publish_to_Relativity_Tool/Publish_to_Relativity_tool.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Publish to Relativity tool", "headings": "Publish to Relativity tool", "name": "Publish to Relativity tool", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Publish to Relativity tool" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Advanced_code_sample_for_database_interactions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Advanced_code_sample_for_database_interactions.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Code sample for database interactions", "headings": "Code sample for database interactions", "name": "Advanced code sample for database interactions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Advanced code sample for database interactions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Basic_concepts_for_Relativity_API_Helpers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Basic_concepts_for_Relativity_API_Helpers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Basic concepts for Relativity API Helpers", "Reference the Relativity.API.dll in your projects", "Connect to the Services API", "Obtain a database context", "Obtain user context information", "Obtain workspace ID", "Obtain the artifact GUID", "Work with the Secret Store", "ISecretStore interface", "Secret class", "Secret path", "Secret store example", "Work with instance settings", "InstanceSettingsBundle interface", "Instance settings example", "Build friendly URLs for custom pages", "Use Relativity API Helpers for unit testing" ], "headings": [ "Basic concepts for Relativity API Helpers", "Reference the Relativity.API.dll in your projects", "Connect to the Services API", "Obtain a database context", "Obtain user context information", "Obtain workspace ID", "Obtain the artifact GUID", "Work with the Secret Store", "ISecretStore interface", "Secret class", "Secret path", "Secret store example", "Work with instance settings", "InstanceSettingsBundle interface", "Instance settings example", "Build friendly URLs for custom pages", "Use Relativity API Helpers for unit testing" ], "name": "Basic concepts for Relativity API Helpers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Basic concepts for Relativity API Helpers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Querying_SMTP_settings_when_sending_email.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Querying_SMTP_settings_when_sending_email.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Query SMTP settings when sending email", "headings": "Query SMTP settings when sending email", "name": "Query SMTP settings when sending email", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Query SMTP settings when sending email" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Relativity_API_Extensions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Relativity_API_Extensions.htm" }, "description": "Use the Relativity.API.Extensions helper functions GetInstanceBaseURL and BuildHTTPAuthorizationHeader to set up REST service calls to a specific environment. Includes a usage example.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity.API.Extensions", "Usage Examples", "FAQs", "Version History" ], "headings": [ "Relativity.API.Extensions", "Usage Examples", "FAQs", "Version History" ], "name": "Relativity API Extensions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the Relativity.API.Extensions helper functions GetInstanceBaseURL and BuildHTTPAuthorizationHeader to set up REST service calls to a specific environment. Includes a usage example.", "title": "Relativity API Extensions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Relativity_API_Extensions_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Relativity_API_Extensions_NET_API_Reference.htm" }, "description": "Reference landing page for the Relativity.Api.Extensions .NET API, which provides helper functions for building service URLs and authorization headers.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity API Extensions .NET API Reference", "Relativity.Api.Extensions" ], "headings": [ "Relativity API Extensions .NET API Reference", "Relativity.Api.Extensions" ], "name": "Relativity API Extensions .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Reference landing page for the Relativity.Api.Extensions .NET API, which provides helper functions for building service URLs and authorization headers.", "title": "Relativity API Extensions .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Relativity_API_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Relativity_API_NET_API_Reference.htm" }, "description": "Reference landing page for the Relativity API Helpers .NET API (Relativity.Api), which provides interfaces for agents, custom pages, and event handlers.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity API Helpers .NET API Reference", "Relativity.Api" ], "headings": [ "Relativity API Helpers .NET API Reference", "Relativity.Api" ], "name": "Relativity API Helpers .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Reference landing page for the Relativity API Helpers .NET API (Relativity.Api), which provides interfaces for agents, custom pages, and event handlers.", "title": "Relativity API Helpers .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/RelativityAPI.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/RelativityAPI.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity.API", "Current Relativity.API content", "Version History" ], "headings": [ "Relativity.API", "Current Relativity.API content", "Version History" ], "name": "Relativity.API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity.API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/RelativityAPIExtensionsNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/RelativityAPIExtensionsNETAPI.html" }, "description": "Relativity API Extensions .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity API Extensions .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity API Extensions .NET API Reference", "title": "Relativity API Extensions .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/RelativityAPINETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/RelativityAPINETAPI.html" }, "description": "Relativity API Helpers .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity API Helpers .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity API Helpers .NET API Reference", "title": "Relativity API Helpers .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Using_Relativity_API_Helpers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_API_Helpers/Using_Relativity_API_Helpers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Relativity API Helpers", "headings": "Relativity API Helpers", "name": "Relativity API Helpers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity API Helpers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Add_a_custom_item_list_to_a_layout.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Add_a_custom_item_list_to_a_layout.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Add a custom item list to a layout", "Adding a new item list \u0026amp; view information", "Overriding default action bar buttons", "Calling an API to get Item list data", "Modifying the view to add field type information", "Turning on sorting", "Enable filtering", "Add custom action buttons", "Custom views", "Refreshing the item list" ], "headings": [ "Add a custom item list to a layout", "Adding a new item list \u0026amp; view information", "Overriding default action bar buttons", "Calling an API to get Item list data", "Modifying the view to add field type information", "Turning on sorting", "Enable filtering", "Add custom action buttons", "Custom views", "Refreshing the item list" ], "name": "Add a custom item list to a layout", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Add a custom item list to a layout" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Additional_Forms_API_objects.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Additional_Forms_API_objects.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Additional Forms API objects", "Summary of additional Forms API objects and functions", "Filter", "eventNames object", "popupControlApi object", "Popup eventHandlerFactory function", "ColumnDefinition class", "ItemListColumn Properties", "CellContent class", "CellContentAlignment enumeration", "HeaderContent class", "IColumnIndicator interface", "FieldMetadata class", "Field Type ID enumeration", "Field Value", "Filter Types enumeration", "QueryRequest class", "Filter class", "Condition class", "Sort class", "QueryResponse class", "itemListDataProvider object", "itemListSettingPersistenceService object", "ItemListMetadata object", "Item List State class", "Item List Types enumeration", "Date Formats", "Relativity object", "ReadData object", "ExitDialog class", "RuntimeConfig class" ], "headings": [ "Additional Forms API objects", "Summary of additional Forms API objects and functions", "Filter", "eventNames object", "popupControlApi object", "Popup eventHandlerFactory function", "ColumnDefinition class", "ItemListColumn Properties", "CellContent class", "CellContentAlignment enumeration", "HeaderContent class", "IColumnIndicator interface", "FieldMetadata class", "Field Type ID enumeration", "Field Value", "Filter Types enumeration", "QueryRequest class", "Filter class", "Condition class", "Sort class", "QueryResponse class", "itemListDataProvider object", "itemListSettingPersistenceService object", "ItemListMetadata object", "Item List State class", "Item List Types enumeration", "Date Formats", "Relativity object", "ReadData object", "ExitDialog class", "RuntimeConfig class" ], "name": "Additional Forms API objects", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Additional Forms API objects" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Common_workflows.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Common_workflows.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Examples", "headings": "Examples", "name": "Examples", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Examples" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Communicate_between_Relativity_Form_pages.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Communicate_between_Relativity_Form_pages.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Communicate between Relativity Form pages", "Guidelines for adding event handlers to a pop-up window", "Write code to add event handlers to a pop-up window", "Example" ], "headings": [ "Communicate between Relativity Form pages", "Guidelines for adding event handlers to a pop-up window", "Write code to add event handlers to a pop-up window", "Example" ], "name": "Communicate between Relativity Form pages", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Communicate between Relativity Form pages" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Convert_to_Relativity_Forms.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Convert_to_Relativity_Forms.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Sample: Converting a Classic Form to a Relativity Form", "Setting up the classic form", "Migrating to Relativity Forms", "Converting the console event handler", "Converting the page interaction event handler", "Updating Relativity assets" ], "headings": [ "Sample: Converting a Classic Form to a Relativity Form", "Setting up the classic form", "Migrating to Relativity Forms", "Converting the console event handler", "Converting the page interaction event handler", "Updating Relativity assets" ], "name": "Sample: Converting a Classic Form to a Relativity Form", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Sample: Converting a Classic Form to a Relativity Form" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Debug_Relativity_Forms_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Debug_Relativity_Forms_event_handlers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Debug Relativity Forms Event Handlers", "RelativityFormsDebugObject", "Adding Breakpoints To Event Handler Code" ], "headings": [ "Debug Relativity Forms Event Handlers", "RelativityFormsDebugObject", "Adding Breakpoints To Event Handler Code" ], "name": "Debug Relativity Forms Event Handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Debug Relativity Forms Event Handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Forms_API_Pipelines.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Forms_API_Pipelines.htm" }, "description": "Section landing page for the Relativity Forms API pipeline topics, such as the Load, Change, and Submit pipelines.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Forms API Pipelines", "headings": "Forms API Pipelines", "name": "Forms API Pipelines", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Section landing page for the Relativity Forms API pipeline topics, such as the Load, Change, and Submit pipelines.", "title": "Forms API Pipelines" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Forms_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Forms_API_Reference.htm" }, "description": "Section landing page for the Relativity Forms API reference content.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Forms API Reference", "headings": "Forms API Reference", "name": "Forms API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Section landing page for the Relativity Forms API reference content.", "title": "Forms API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Implementing_Relativity_Forms_event_handlers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Implementing_Relativity_Forms_event_handlers.htm" }, "description": "Learn how to implement Relativity Forms page interaction event handlers in JavaScript files and reference them from the .NET PageInteractionEventHandler class using ScriptFileNames.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Implementing Relativity Forms event handlers", "Guidelines for page interaction event handlers", "Customizing Relativity Forms pages with the Relativity Forms API", "Identifying the URL for a file", "Updating custom event handler script files", "Considerations" ], "headings": [ "Implementing Relativity Forms event handlers", "Guidelines for page interaction event handlers", "Customizing Relativity Forms pages with the Relativity Forms API", "Identifying the URL for a file", "Updating custom event handler script files", "Considerations" ], "name": "Implementing Relativity Forms event handlers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Learn how to implement Relativity Forms page interaction event handlers in JavaScript files and reference them from the .NET PageInteractionEventHandler class using ScriptFileNames.", "title": "Implementing Relativity Forms event handlers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Migrating_To_Relativity_Forms.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Migrating_To_Relativity_Forms.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Migrating applications to Relativity Forms", "Determining if your applications are affected", "Classic Forms Deprecation Compliance Identification Tool", "Conceptual Differences", "Considerations", "Frequently Asked Questions" ], "headings": [ "Migrating applications to Relativity Forms", "Determining if your applications are affected", "Classic Forms Deprecation Compliance Identification Tool", "Conceptual Differences", "Considerations", "Frequently Asked Questions" ], "name": "Migrating applications to Relativity Forms", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Migrating applications to Relativity Forms" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Relativity_Forms_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Relativity_Forms_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Forms API", "What is Relativity Forms?", "Concepts" ], "headings": [ "Relativity Forms API", "What is Relativity Forms?", "Concepts" ], "name": "Relativity Forms API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity Forms API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Relativity_Forms_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Forms/Relativity_Forms_API_Reference.htm" }, "description": "Section landing page for the Relativity Forms API reference content.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Relativity Forms API Reference", "headings": "Relativity Forms API Reference", "name": "Relativity Forms API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Section landing page for the Relativity Forms API reference content.", "title": "Relativity Forms API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Best_practices_for_integration_point_development.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Best_practices_for_integration_point_development.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Best practices for integration point development", "Use separate projects for custom page and provider code", "Reference the required Relativity libraries in your projects", "Create a custom application in Relativity", "Use GUIDs in your source code", "Subscribe to required JavaScript events", "Reference required JavaScript files in the view", "Include event handlers for your provider", "Display source provider settings selected by users", "Define a method for returning key-value pairs", "Set the ViewDataUrl property", "Use methods for batching in your provider code", "Upload .dll files to Relativity in the correct order", "Use unique identifiers and display names in your data", "Verify your IIS configuration", "Use secured configurations for sensitive information", "V1 endpoints for custom providers", "Migration to V2 endpoints for custom providers" ], "headings": [ "Best practices for integration point development", "Use separate projects for custom page and provider code", "Reference the required Relativity libraries in your projects", "Create a custom application in Relativity", "Use GUIDs in your source code", "Subscribe to required JavaScript events", "Reference required JavaScript files in the view", "Include event handlers for your provider", "Display source provider settings selected by users", "Define a method for returning key-value pairs", "Set the ViewDataUrl property", "Use methods for batching in your provider code", "Upload .dll files to Relativity in the correct order", "Use unique identifiers and display names in your data", "Verify your IIS configuration", "Use secured configurations for sensitive information", "V1 endpoints for custom providers", "Migration to V2 endpoints for custom providers" ], "name": "Best Practices", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Best Practices" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Build_an_advanced_integration_point.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Build_an_advanced_integration_point.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Build an advanced integration point", "View the source code", "Build the JSON Loader in Visual Studio" ], "headings": [ "Build an advanced integration point", "View the source code", "Build the JSON Loader in Visual Studio" ], "name": "Build an advanced integration point", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Build an advanced integration point" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Build_your_first_integration_point.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Build_your_first_integration_point.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Build your first integration point", "Before you begin", "Create a Relativity application", "Set up your Visual Studio solution", "Define global constants", "Develop code for the client interface", "Add custom code to the controller", "Add a custom JavaScript file", "Add custom code to the view", "Add a custom CSS file", "Develop code for your provider", "Add a provider class", "Add a data reader class", "Add event handlers for registering and uninstalling your provider", "Compile your source code", "Deploy your integration point", "Upload required .dll files", "Publish your custom page project", "Upload your custom page", "Install your application", "Use your integration point in Relativity" ], "headings": [ "Build your first integration point", "Before you begin", "Create a Relativity application", "Set up your Visual Studio solution", "Define global constants", "Develop code for the client interface", "Add custom code to the controller", "Add a custom JavaScript file", "Add custom code to the view", "Add a custom CSS file", "Develop code for your provider", "Add a provider class", "Add a data reader class", "Add event handlers for registering and uninstalling your provider", "Compile your source code", "Deploy your integration point", "Upload required .dll files", "Publish your custom page project", "Upload your custom page", "Install your application", "Use your integration point in Relativity" ], "name": "Build your first integration point", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Build your first integration point" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Get_started_with_integration_points.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Get_started_with_integration_points.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Integration Points", "Understand the Relativity Integration Points framework", "Basic concepts for integration point development", "Workflow for importing data", "Relativity Integration Points API", "Integration Points SDK files" ], "headings": [ "Relativity Integration Points", "Understand the Relativity Integration Points framework", "Basic concepts for integration point development", "Workflow for importing data", "Relativity Integration Points API", "Integration Points SDK files" ], "name": "Relativity Integration Points", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity Integration Points" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Troubleshoot_integration_points.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Integration_Points/Troubleshoot_integration_points.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Troubleshoot and upgrade integration points", "Upgrade integration points for use in Relativity 9.4 and above", "Update the .dll references in your projects", "Update the use of dependency injection", "Recompile and upload your integration point", "Upload remaining assemblies to Relativity", "Troubleshoot integration points", "Integration point doesn\u0027t run", "Integration point exhibits poor performance", "Debug an integration point" ], "headings": [ "Troubleshoot and upgrade integration points", "Upgrade integration points for use in Relativity 9.4 and above", "Update the .dll references in your projects", "Update the use of dependency injection", "Recompile and upload your integration point", "Upload remaining assemblies to Relativity", "Troubleshoot integration points", "Integration point doesn\u0027t run", "Integration point exhibits poor performance", "Debug an integration point" ], "name": "Troubleshoot and upgrade integration points", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Troubleshoot and upgrade integration points" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/API_error_handling.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/API_error_handling.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "API error handling", "Errors in RESTful services", "Handling errors", "Error handling in .NET", "Error code changes over time", "Best practices for error handling" ], "headings": [ "API error handling", "Errors in RESTful services", "Handling errors", "Error handling in .NET", "Error code changes over time", "Best practices for error handling" ], "name": "Relativity API error handling", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity API error handling" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Data_Import_and_Export_APIs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Data_Import_and_Export_APIs.htm" }, "description": "Compare the Relativity APIs for transferring data to and from Relativity, including the Import Service, Export Service, Transfer API, and Relativity Transfer SDK.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Data Import and Export APIs", "headings": "Data Import and Export APIs", "name": "Data Import and Export APIs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Compare the Relativity APIs for transferring data to and from Relativity, including the Import Service, Export Service, Transfer API, and Relativity Transfer SDK.", "title": "Data Import and Export APIs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Documentation_archives.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Documentation_archives.htm" }, "description": "If you need technical assistance, contact our Support team via the information on our Support page.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Documentation archives", "Proprietary Rights" ], "headings": [ "Documentation archives", "Proprietary Rights" ], "name": "Documentation archives", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "If you need technical assistance, contact our Support team via the information on our Support page.", "title": "Documentation archives" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Get_started.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Get_started.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Tools and Resources", "SDKs, APIs, NuGet packages, and templates", "Developer Support" ], "headings": [ "Tools and Resources", "SDKs, APIs, NuGet packages, and templates", "Developer Support" ], "name": "Tools and Resources", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Tools and Resources" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/index.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/index.htm" }, "description": "Developer documentation for RelativityOne and Relativity Server. Find what you need by level or search the site.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Developer Documentation", "Browse content", "Explore", "Integrate", "Extend", "Additional Developer Resources" ], "headings": [ "Developer Documentation", "Browse content", "Explore", "Integrate", "Extend", "Additional Developer Resources" ], "name": "Relativity developer documentation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Developer documentation for RelativityOne and Relativity Server. Find what you need by level or search the site.", "title": "Relativity developer documentation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Platform_API_Rate_Limits.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Platform_API_Rate_Limits.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Platform API rate limits", "Exceeding the limit", "Rate limit response headers", "HTTP status codes", "Handling rate limit errors" ], "headings": [ "Platform API rate limits", "Exceeding the limit", "Rate limit response headers", "HTTP status codes", "Handling rate limit errors" ], "name": "Platform API rate limits", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Platform API rate limits" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Platform_APIs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Platform_APIs.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity aiR APIs", "Integration APIs", "Extension APIs" ], "headings": [ "Relativity aiR APIs", "Integration APIs", "Extension APIs" ], "name": "Relativity aiR Platform APIs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity aiR Platform APIs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Platform_Extension_APIs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Platform_Extension_APIs.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Platform Extension APIs", "headings": "Platform Extension APIs", "name": "Platform Extension APIs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Platform Extension APIs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_API_reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_API_reference.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Class library reference", "Integration APIs", "Extension APIs" ], "headings": [ "Class library reference", "Integration APIs", "Extension APIs" ], "name": "Relativity API reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity API reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Builders.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Builders.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Export Service API builders", "Export Builders", "Export source settings", "Export Artifact settings", "Export Subdirectory settings", "Export job settings" ], "headings": [ "Export Service API builders", "Export Builders", "Export source settings", "Export Artifact settings", "Export Subdirectory settings", "Export job settings" ], "name": "Export Service API builders", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Export Service API builders" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Export_job.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Export_job.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Export job", "Create an export job configuration", "Create an export job", "Start an export job", "Check export job status", "Export Job States" ], "headings": [ "Export job", "Create an export job configuration", "Create an export job", "Start an export job", "Check export job status", "Export Job States" ], "name": "Import documents", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Import documents" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Getting_Started.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Getting_Started.htm" }, "description": "Get started with the Export Service API, including the required applications, permissions, client packages, and authentication methods for HTTP and Kepler .NET clients.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Getting started", "Prerequisites", "Authorization", "Permissions", "Make calls to export service", "HTTP clients", "Kepler .NET client" ], "headings": [ "Getting started", "Prerequisites", "Authorization", "Permissions", "Make calls to export service", "HTTP clients", "Kepler .NET client" ], "name": "Getting started", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Get started with the Export Service API, including the required applications, permissions, client packages, and authentication methods for HTTP and Kepler .NET clients.", "title": "Getting started" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Sample_types_and_structure.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Getting_Started/Sample_types_and_structure.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Samples types and structure", "KeplerClient Code Samples" ], "headings": [ "Samples types and structure", "KeplerClient Code Samples" ], "name": "Samples types and structure", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Samples types and structure" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Overview/Handling_error_codes.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Overview/Handling_error_codes.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Handle Export Service API errors and exceptions", "Error code structure", "Sources", "Error Types", "Operations", "Error numbers" ], "headings": [ "Handle Export Service API errors and exceptions", "Error code structure", "Sources", "Error Types", "Operations", "Error numbers" ], "name": "Handle Import Service API errors and exceptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Handle Import Service API errors and exceptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Overview/Relativity_Export_Service_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Overview/Relativity_Export_Service_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Export Service API", "Version History", "Relativity.Export.SDK" ], "headings": [ "Relativity Export Service API", "Version History", "Relativity.Export.SDK" ], "name": "Relativity Export Service API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity Export Service API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Relativity_Export_SDK_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/Relativity_Export_SDK_Reference.htm" }, "description": "Reference landing page for the Relativity Export SDK .NET API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Relativity Export SDK API Reference", "headings": "Relativity Export SDK API Reference", "name": "Relativity Export SDK Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Reference landing page for the Relativity Export SDK .NET API.", "title": "Relativity Export SDK Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/RelativityExportSDKRESTAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/RelativityExportSDKRESTAPI.html" }, "description": "Relativity Export SDK API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity Export SDK API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity Export SDK API Reference", "title": "Relativity Export SDK API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/RelativityExportService_API.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/RelativityExportService_API.html" }, "description": "Relativity Import Service API REST Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity Import Service API REST Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity Import Service API REST Reference", "title": "Relativity Import Service API REST Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/RelativityExportService_REST_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Relativity_Export_SDK/RelativityExportService_REST_API_Reference.htm" }, "description": "Reference landing page for the Relativity Export Service REST API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Export Service REST API Reference", "Relativity.Export" ], "headings": [ "Relativity Export Service REST API Reference", "Relativity.Export" ], "name": "Relativity Export Service REST API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Reference landing page for the Relativity Export Service REST API.", "title": "Relativity Export Service REST API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/SDK_API_Comparison.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/SDK_API_Comparison.htm" }, "description": "Lists and compares the available APIs in Relativity aiR and Relativity Server", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "SDK and API comparison: Relativity aiR vs Relativity Server", ".NET\u0026#160;SDKs", "REST\u0026#160;APIs", "JavaScript APIs" ], "headings": [ "SDK and API comparison: Relativity aiR vs Relativity Server", ".NET\u0026#160;SDKs", "REST\u0026#160;APIs", "JavaScript APIs" ], "name": "SDK and API Comparison: Relativity aiR vs Relativity Server", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Lists and compares the available APIs in Relativity aiR and Relativity Server", "title": "SDK and API Comparison: Relativity aiR vs Relativity Server" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Testing_custom_applications.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/Testing_custom_applications.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Testing custom applications", "Types of tests for custom applications", "Unit tests", "Integration tests", "Continuous integration testing", "Code coverage", "Testable code", "Steps for writing unit tests", "Testing Sandboxes for Relativity aiR applications", "Automated tests in Relativity aiR Sandboxes", "Recommendations for application development", "Additional testing resources", "Relativity repository on GitHub", "Additional NUnit testing information", "Visual Studio templates" ], "headings": [ "Testing custom applications", "Types of tests for custom applications", "Unit tests", "Integration tests", "Continuous integration testing", "Code coverage", "Testable code", "Steps for writing unit tests", "Testing Sandboxes for Relativity aiR applications", "Automated tests in Relativity aiR Sandboxes", "Recommendations for application development", "Additional testing resources", "Relativity repository on GitHub", "Additional NUnit testing information", "Visual Studio templates" ], "name": "Testing custom applications", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Testing custom applications" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/UI_Customization_APIs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Relativity_Platform/UI_Customization_APIs.htm" }, "description": "Get an overview of the JavaScript UI customization APIs, including the Relativity Forms API, Lists Interaction APIs, Review API, and supported JavaScript APIs.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "UI Customization APIs", "headings": "UI Customization APIs", "name": "UI Customization APIs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Get an overview of the JavaScript UI customization APIs, including the Relativity Forms API, Lists Interaction APIs, Review API, and supported JavaScript APIs.", "title": "UI Customization APIs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/RelativityaiR/RelativityOne_developer_considerations.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/RelativityaiR/RelativityOne_developer_considerations.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity aiR developer considerations", "Relativity aiR architectural overview", "Infrastructure", "Relativity aiR fundamentals", "Application integration", "SQL server coding considerations", "SQL tenant admin operational overview", "Analytics servers", "Data Grid", "Internet Information Services (IIS) and Windows Services", "Application development", "General best practices for Relativity aiR", "Applications with external dependencies", "Application performance", "Input/Output (I/O) considerations", "Azure load balancing considerations", "Data storage", "Import and store data in Relativity aiR", "Import options for Relativity aiR", "Cloud data storage", "Security considerations", "TLS 1.2 support", "Customer lockbox and system admin access rights", "Relativity aiR Government", "Relativity aiR Sandbox" ], "headings": [ "Relativity aiR developer considerations", "Relativity aiR architectural overview", "Infrastructure", "Relativity aiR fundamentals", "Application integration", "SQL server coding considerations", "SQL tenant admin operational overview", "Analytics servers", "Data Grid", "Internet Information Services (IIS) and Windows Services", "Application development", "General best practices for Relativity aiR", "Applications with external dependencies", "Application performance", "Input/Output (I/O) considerations", "Azure load balancing considerations", "Data storage", "Import and store data in Relativity aiR", "Import options for Relativity aiR", "Cloud data storage", "Security considerations", "TLS 1.2 support", "Customer lockbox and system admin access rights", "Relativity aiR Government", "Relativity aiR Sandbox" ], "name": "Relativity aiR developer considerations", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity aiR developer considerations" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/RelativityaiR/RelativityOne_Sandbox.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/RelativityaiR/RelativityOne_Sandbox.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity aiR Sandbox", "Accessing Sandbox environments", "Managing user access to your Sandbox", "Upgrades of your Sandbox environments", "Sandbox extended downtime windows", "Using Sandboxes to troubleshoot custom applications", "Differences between production and Sandbox environments", "Infrastructure", "Sandbox Support policies" ], "headings": [ "Relativity aiR Sandbox", "Accessing Sandbox environments", "Managing user access to your Sandbox", "Upgrades of your Sandbox environments", "Sandbox extended downtime windows", "Using Sandboxes to troubleshoot custom applications", "Differences between production and Sandbox environments", "Infrastructure", "Sandbox Support policies" ], "name": "Relativity aiR Sandbox", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity aiR Sandbox" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/REST_API/HTTP_headers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/REST_API/HTTP_headers.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "HTTP headers", "headings": "HTTP headers", "name": "HTTP headers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "HTTP headers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/REST_API/HTTP_status_codes.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/REST_API/HTTP_status_codes.htm" }, "description": "The Relativity REST APIs return the common status codes in HTTP responses. This page contains the status codes and their descriptions used in Relativity.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "HTTP status codes in Relativity REST APIs", "headings": "HTTP status codes in Relativity REST APIs", "name": "HTTP status codes in Relativity REST APIs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The Relativity REST APIs return the common status codes in HTTP responses. This page contains the status codes and their descriptions used in Relativity.", "title": "HTTP status codes in Relativity REST APIs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/REST_API/Resource_Tasks/Querying_for_resources.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/REST_API/Resource_Tasks/Querying_for_resources.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Query for resources", "Query options", "Syntax for query conditions", "Wildcard characters", "Special characters", "Supported data grid query operators", "Queries on multiple object fields" ], "headings": [ "Query for resources", "Query options", "Syntax for query conditions", "Wildcard characters", "Special characters", "Supported data grid query operators", "Queries on multiple object fields" ], "name": "Query for resources", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Query for resources" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "REST API", "headings": "REST API", "name": "REST API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "REST API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API_authentication.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API_authentication.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity REST API authentication", "Cookie authentication", "Cookie authentication from JavaScript", "Bearer token authentication", "Bearer Token Authentication", "Bearer Access tokens in PowerShell" ], "headings": [ "Relativity REST API authentication", "Cookie authentication", "Cookie authentication from JavaScript", "Bearer token authentication", "Bearer Token Authentication", "Bearer Access tokens in PowerShell" ], "name": "Relativity REST API authentication", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity REST API authentication" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API_concepts/Relativity_REST_API_architecture.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API_concepts/Relativity_REST_API_architecture.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Relativity REST API architecture", "headings": "Relativity REST API architecture", "name": "Relativity REST API architecture", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity REST API architecture" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API_concepts/REST_API_and_RESTful_concepts.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_API_concepts/REST_API_and_RESTful_concepts.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "REST API overview", "REST API features", "RESTful concepts", "Unique implementation details" ], "headings": [ "REST API overview", "REST API features", "RESTful concepts", "Unique implementation details" ], "name": "Basic REST API concepts", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Basic REST API concepts" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_services/Folder_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_services/Folder_Manager_service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Folder Manager (REST)", "Client code sample", "HTTP headers and status codes", "Create a folder", "Update a folder", "Delete unused folders", "Query for folders", "Helper methods", "Retrieve workspace root Folder", "Retrieve subfolders", "Retrieve expanded Folder nodes", "Get folder access status", "Move folders" ], "headings": [ "Folder Manager (REST)", "Client code sample", "HTTP headers and status codes", "Create a folder", "Update a folder", "Delete unused folders", "Query for folders", "Helper methods", "Retrieve workspace root Folder", "Retrieve subfolders", "Retrieve expanded Folder nodes", "Get folder access status", "Move folders" ], "name": "Folder Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Folder Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_services/Search_Container_Manager_service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/REST_API/REST_services/Search_Container_Manager_service.htm" }, "description": "This topic describes how to interact with the Relativity SearchContainer object using the REST API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Search Container Manager (REST)", "Client code sample", "Create", "Read", "Update", "Delete", "Query", "Move", "Get folder content", "GetSearchContainerItemsAsync", "GetChildSearchContainersAsync", "Retrieve expanded search container nodes", "GetSearchContainerTreeAsync", "GetFilteredSearchContainerTreeAsync", "Retrieve Advanced Search View fields", "GetAdvancedSearchViewInfoAsync", "GetAdvancedSearchViewUniqueCreatedByAsync", "GetAdvancedSearchViewUniqueModifiedByAsync", "GetAdvancedSearchViewUniqueOwnersAsync" ], "headings": [ "Search Container Manager (REST)", "Client code sample", "Create", "Read", "Update", "Delete", "Query", "Move", "Get folder content", "GetSearchContainerItemsAsync", "GetChildSearchContainersAsync", "Retrieve expanded search container nodes", "GetSearchContainerTreeAsync", "GetFilteredSearchContainerTreeAsync", "Retrieve Advanced Search View fields", "GetAdvancedSearchViewInfoAsync", "GetAdvancedSearchViewUniqueCreatedByAsync", "GetAdvancedSearchViewUniqueModifiedByAsync", "GetAdvancedSearchViewUniqueOwnersAsync" ], "name": "Search Container Manager (REST)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This topic describes how to interact with the Relativity SearchContainer object using the REST API.", "title": "Search Container Manager (REST)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/REST_API/Troubleshooting/Troubleshooting_the_REST_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/REST_API/Troubleshooting/Troubleshooting_the_REST_API.htm" }, "description": "Use the information in the following sections to troubleshoot operations performed through the REST API.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Troubleshoot REST API errors", "HTTP method fails", "Incorrect maxRequestLength parameter", "Unable to update or delete resources" ], "headings": [ "Troubleshoot REST API errors", "HTTP method fails", "Incorrect maxRequestLength parameter", "Unable to update or delete resources" ], "name": "Troubleshoot REST API errors", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Use the information in the following sections to troubleshoot operations performed through the REST API.", "title": "Troubleshoot REST API errors" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/About_Relativity_Review.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/About_Relativity_Review.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "About Relativity Review", "headings": "About Relativity Review", "name": "About Relativity Review", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "About Relativity Review" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Accessing_the_Relativity_Review_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Accessing_the_Relativity_Review_API.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Accessing the Relativity Review API", "Relativity Review API availability", "Verify that Relativity Review is enabled", "Listen for ready events" ], "headings": [ "Accessing the Relativity Review API", "Relativity Review API availability", "Verify that Relativity Review is enabled", "Listen for ready events" ], "name": "Accessing the Relativity Review API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Accessing the Relativity Review API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Adding_custom_content.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Adding_custom_content.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Adding Custom Content", "Cards", "Registering cards", "Card loaders", "Custom loader (recommended)", "IFrame loader", "ViewModel loader", "Toolbar controls", "Context menu items", "Document content overlays" ], "headings": [ "Adding Custom Content", "Cards", "Registering cards", "Card loaders", "Custom loader (recommended)", "IFrame loader", "ViewModel loader", "Toolbar controls", "Context menu items", "Document content overlays" ], "name": "Adding Custom Content", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Adding Custom Content" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Annotations.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Annotations.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Annotations", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "headings": [ "Annotations", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "name": "Annotations", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Annotations" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/API.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "API", "Index", "Enumerations", "Interfaces" ], "headings": [ "API", "Index", "Enumerations", "Interfaces" ], "name": "API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Batches.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Batches.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Batches", "Index", "Interfaces" ], "headings": [ "Batches", "Index", "Interfaces" ], "name": "Batches", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Batches" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Building_An_Extension.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Building_An_Extension.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Building An Extension", "Step 1 - Create a Relativity application", "Step 2 - Create an extension script", "Extension script requirements", "Extension script parameters", "Extension script example", "Step 3 - Upload your extension script to Relativity", "Step 4 - Optionally upload other static files to Relativity", "Additional considerations" ], "headings": [ "Building An Extension", "Step 1 - Create a Relativity application", "Step 2 - Create an extension script", "Extension script requirements", "Extension script parameters", "Extension script example", "Step 3 - Upload your extension script to Relativity", "Step 4 - Optionally upload other static files to Relativity", "Additional considerations" ], "name": "Building An Extension", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Building An Extension" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Building_extensions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Building_extensions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Building extensions", "headings": "Building extensions", "name": "Building extensions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Building extensions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Cancellation.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Cancellation.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Cancellation", "Index", "Classes", "Interfaces" ], "headings": [ "Cancellation", "Index", "Classes", "Interfaces" ], "name": "Cancellation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Cancellation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Card_Locations.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Card_Locations.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Card Locations", "Basic layout concepts", "Dock", "Accordion", "Review layout - left", "Left accordion in document review", "Review layout - right", "Right accordion in document review", "Viewer collection layout - left", "Viewer left dock in document review", "Viewer left dock in document preview", "Viewer collection layout - right", "Viewer right dock in document review", "Viewer dock layout - bottom", "Dock at bottom of document review interface", "Dock at bottom of document preview interface" ], "headings": [ "Card Locations", "Basic layout concepts", "Dock", "Accordion", "Review layout - left", "Left accordion in document review", "Review layout - right", "Right accordion in document review", "Viewer collection layout - left", "Viewer left dock in document review", "Viewer left dock in document preview", "Viewer collection layout - right", "Viewer right dock in document review", "Viewer dock layout - bottom", "Dock at bottom of document review interface", "Dock at bottom of document preview interface" ], "name": "Card Locations", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Card Locations" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Cards.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Cards.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Cards", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "headings": [ "Cards", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "name": "Cards", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Cards" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Cards_1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Cards_1.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Cards", "Cards", "Define a config object for a card", "Create a card", "Create cards in response to the ApiReady event", "Create a card on the fly", "Optionally pass additional arguments during card creation", "Card loaders", "IFrame cards", "Access the card object from within the IFrame", "Auto resolve", "Custom cards", "Communication between cards", "Card skeleton", "Defining card skeleton", "Showing card skeleton explicitly", "Hiding card skeleton explicitly", "Report errors", "Set card states", "Synchronize with the viewer" ], "headings": [ "Cards", "Cards", "Define a config object for a card", "Create a card", "Create cards in response to the ApiReady event", "Create a card on the fly", "Optionally pass additional arguments during card creation", "Card loaders", "IFrame cards", "Access the card object from within the IFrame", "Auto resolve", "Custom cards", "Communication between cards", "Card skeleton", "Defining card skeleton", "Showing card skeleton explicitly", "Hiding card skeleton explicitly", "Report errors", "Set card states", "Synchronize with the viewer" ], "name": "Cards", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Cards" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Changes_to_Integration_Development.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Changes_to_Integration_Development.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Changes to Integration Development", "Legacy versus new review integrations", "Relativity Forms Page Interaction event handlers", "Relativity Review Extensions", "Next steps for migration" ], "headings": [ "Changes to Integration Development", "Legacy versus new review integrations", "Relativity Forms Page Interaction event handlers", "Relativity Review Extensions", "Next steps for migration" ], "name": "Changes to Integration Development", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Changes to Integration Development" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Class_ContextMenuOption.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Class_ContextMenuOption.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Class: ContextMenuOption", "Constructors", "new ContextMenuOption()", "Properties", "callback()", "disabled", "icon?", "items?", "name", "rwcIcon?", "rwcIconClass?", "rwcIconColor?", "visible" ], "headings": [ "Class: ContextMenuOption", "Constructors", "new ContextMenuOption()", "Properties", "callback()", "disabled", "icon?", "items?", "name", "rwcIcon?", "rwcIconClass?", "rwcIconColor?", "visible" ], "name": "Class: ContextMenuOption", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Class: ContextMenuOption" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Class_Cursor.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Class_Cursor.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Class: Cursor", "Constructors", "new Cursor()", "Properties", "x", "y" ], "headings": [ "Class: Cursor", "Constructors", "new Cursor()", "Properties", "x", "y" ], "name": "Class: Cursor", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Class: Cursor" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Class_OperationCancelledError.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Class_OperationCancelledError.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Class: OperationCancelledError", "Extends", "Constructors", "new OperationCancelledError()" ], "headings": [ "Class: OperationCancelledError", "Extends", "Constructors", "new OperationCancelledError()" ], "name": "Class: OperationCancelledError", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Class: OperationCancelledError" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Coding.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Coding.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Coding", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "headings": [ "Coding", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "name": "Coding", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Coding" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Coding_Card.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Coding_Card.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Coding Card", "headings": "Coding Card", "name": "Coding Card", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Coding Card" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Conditionally_Registering_Extensions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Conditionally_Registering_Extensions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Conditionally Registering Extensions", "Example" ], "headings": [ "Conditionally Registering Extensions", "Example" ], "name": "Conditionally Registering Extensions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Conditionally Registering Extensions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Configuration.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Configuration.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Configuration", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "headings": [ "Configuration", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "name": "Configuration", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Configuration" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Content_Highlighting_Framework.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Content_Highlighting_Framework.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Content Highlighting Framework", "Overview", "Content highlighting features", "Getting Started", "Controlling feature availability", "Enabling features in specific viewer types", "Render functions", "Render function basics", "Render function data retrieval", "Render function highlighting", "Highlighting", "Highlight sets", "Highlights", "Controlling highlight visibility", "Highlighting events", "Content highlighting cards", "The \"late-open\" problem", "Defining the card", "Accessing the Content Highlighting Card API", "Using the Content Highlighting Card API", "Controlling card visibility", "Passing custom data from render functions to highlighting cards", "Syncing text highlights across viewer types", "Challenges with cross-viewer text highlighting", "Best practices for syncing cross-viewer text highlights" ], "headings": [ "Content Highlighting Framework", "Overview", "Content highlighting features", "Getting Started", "Controlling feature availability", "Enabling features in specific viewer types", "Render functions", "Render function basics", "Render function data retrieval", "Render function highlighting", "Highlighting", "Highlight sets", "Highlights", "Controlling highlight visibility", "Highlighting events", "Content highlighting cards", "The \"late-open\" problem", "Defining the card", "Accessing the Content Highlighting Card API", "Using the Content Highlighting Card API", "Controlling card visibility", "Passing custom data from render functions to highlighting cards", "Syncing text highlights across viewer types", "Challenges with cross-viewer text highlighting", "Best practices for syncing cross-viewer text highlights" ], "name": "Content Highlighting Framework", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Content Highlighting Framework" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ContentHighlighting.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ContentHighlighting.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ContentHighlighting", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "headings": [ "ContentHighlighting", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "name": "ContentHighlighting", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ContentHighlighting" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Context_Menus.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Context_Menus.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Context Menus", "Add context menu items", "Additional configurations" ], "headings": [ "Context Menus", "Add context menu items", "Additional configurations" ], "name": "Context Menus", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Context Menus" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ContextMenu.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ContextMenu.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ContextMenu", "Index", "Classes", "Interfaces" ], "headings": [ "ContextMenu", "Index", "Classes", "Interfaces" ], "name": "ContextMenu", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ContextMenu" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ConvenienceApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ConvenienceApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ConvenienceApi", "Index", "Interfaces" ], "headings": [ "ConvenienceApi", "Index", "Interfaces" ], "name": "ConvenienceApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ConvenienceApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Creating_Viewer_Types.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Creating_Viewer_Types.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Creating Viewer Types", "Step 1 - Create a viewer card definition", "viewerType property", "createInstance property", "supportsItem property", "Step 2 - Implement the viewer card instance", "Step 3 - Register the viewer card definition", "Next steps" ], "headings": [ "Creating Viewer Types", "Step 1 - Create a viewer card definition", "viewerType property", "createInstance property", "supportsItem property", "Step 2 - Implement the viewer card instance", "Step 3 - Register the viewer card definition", "Next steps" ], "name": "Creating Viewer Types", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Creating Viewer Types" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Custom_Viewer_Types.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Custom_Viewer_Types.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Custom Viewer Types", "headings": "Custom Viewer Types", "name": "Custom Viewer Types", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Custom Viewer Types" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Document.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Document.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Document", "Index", "Enumerations", "Interfaces" ], "headings": [ "Document", "Index", "Enumerations", "Interfaces" ], "name": "Document", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Document" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/DocumentActions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/DocumentActions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "DocumentActions", "Index", "Interfaces" ], "headings": [ "DocumentActions", "Index", "Interfaces" ], "name": "DocumentActions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "DocumentActions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/DocumentHistory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/DocumentHistory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "DocumentHistory", "Index", "Interfaces" ], "headings": [ "DocumentHistory", "Index", "Interfaces" ], "name": "DocumentHistory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "DocumentHistory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/DocumentList.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/DocumentList.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "DocumentList", "Index", "Interfaces" ], "headings": [ "DocumentList", "Index", "Interfaces" ], "name": "DocumentList", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "DocumentList" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ECMAScript_requirements.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ECMAScript_requirements.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ECMAScript requirements", "Browser compatibility references" ], "headings": [ "ECMAScript requirements", "Browser compatibility references" ], "name": "ECMAScript requirements", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ECMAScript requirements" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_AnnotationType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_AnnotationType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: AnnotationType", "Enumeration Members", "Highlight", "Redaction" ], "headings": [ "Enumeration: AnnotationType", "Enumeration Members", "Highlight", "Redaction" ], "name": "Enumeration: AnnotationType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: AnnotationType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_AnnotationVisibilityType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_AnnotationVisibilityType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: AnnotationVisibilityType", "Enumeration Members", "Hidden", "Transparent", "Visible" ], "headings": [ "Enumeration: AnnotationVisibilityType", "Enumeration Members", "Hidden", "Transparent", "Visible" ], "name": "Enumeration: AnnotationVisibilityType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: AnnotationVisibilityType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ApplicationContext.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ApplicationContext.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ApplicationContext", "Enumeration Members", "ClassicEmbedded", "Embedded", "ExternalStandalone", "Mobile", "Preview", "ReviewInterface" ], "headings": [ "Enumeration: ApplicationContext", "Enumeration Members", "ClassicEmbedded", "Embedded", "ExternalStandalone", "Mobile", "Preview", "ReviewInterface" ], "name": "Enumeration: ApplicationContext", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ApplicationContext" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ApplicationLifecycleEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ApplicationLifecycleEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ApplicationLifecycleEventType", "Enumeration Members", "Activated", "ApiReady", "CanDeactivate", "CanTeardown", "Deactivated", "Ready", "Teardown" ], "headings": [ "Enumeration: ApplicationLifecycleEventType", "Enumeration Members", "Activated", "ApiReady", "CanDeactivate", "CanTeardown", "Deactivated", "Ready", "Teardown" ], "name": "Enumeration: ApplicationLifecycleEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ApplicationLifecycleEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ApplicationWindowEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ApplicationWindowEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ApplicationWindowEventType", "Enumeration Members", "CanClose", "Close", "Resized" ], "headings": [ "Enumeration: ApplicationWindowEventType", "Enumeration Members", "CanClose", "Close", "Resized" ], "name": "Enumeration: ApplicationWindowEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ApplicationWindowEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_AuthMode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_AuthMode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: AuthMode", "Enumeration Members", "BearerToken", "Cookie" ], "headings": [ "Enumeration: AuthMode", "Enumeration Members", "BearerToken", "Cookie" ], "name": "Enumeration: AuthMode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: AuthMode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_BorderStyle.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_BorderStyle.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: BorderStyle", "Enumeration Members", "dash", "dashdot", "dashdotdot", "dot", "none", "solid" ], "headings": [ "Enumeration: BorderStyle", "Enumeration Members", "dash", "dashdot", "dashdotdot", "dot", "none", "solid" ], "name": "Enumeration: BorderStyle", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: BorderStyle" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CardBannerType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CardBannerType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: CardBannerType", "Enumeration Members", "HTML", "Message" ], "headings": [ "Enumeration: CardBannerType", "Enumeration Members", "HTML", "Message" ], "name": "Enumeration: CardBannerType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: CardBannerType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CardLayoutId.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CardLayoutId.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: CardLayoutId", "Enumeration Members", "Overlay", "Popout", "Review", "SmartHighlights", "ViewerCollection", "ViewerDock" ], "headings": [ "Enumeration: CardLayoutId", "Enumeration Members", "Overlay", "Popout", "Review", "SmartHighlights", "ViewerCollection", "ViewerDock" ], "name": "Enumeration: CardLayoutId", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: CardLayoutId" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CardStatus.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CardStatus.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: CardStatus", "Enumeration Members", "Failed", "Loaded", "Loading", "Uninitialized", "Unloaded", "Unloading" ], "headings": [ "Enumeration: CardStatus", "Enumeration Members", "Failed", "Loaded", "Loading", "Uninitialized", "Unloaded", "Unloading" ], "name": "Enumeration: CardStatus", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: CardStatus" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ChoiceFieldType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ChoiceFieldType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ChoiceFieldType", "Enumeration Members", "Multiple", "Single" ], "headings": [ "Enumeration: ChoiceFieldType", "Enumeration Members", "Multiple", "Single" ], "name": "Enumeration: ChoiceFieldType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ChoiceFieldType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ComponentConflictBehavior.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ComponentConflictBehavior.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ComponentConflictBehavior", "Enumeration Members", "Fail", "Register", "Unregister" ], "headings": [ "Enumeration: ComponentConflictBehavior", "Enumeration Members", "Fail", "Register", "Unregister" ], "name": "Enumeration: ComponentConflictBehavior", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ComponentConflictBehavior" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ConfigurationEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ConfigurationEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ConfigurationEventType", "Enumeration Members", "ConfigurationChanged" ], "headings": [ "Enumeration: ConfigurationEventType", "Enumeration Members", "ConfigurationChanged" ], "name": "Enumeration: ConfigurationEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ConfigurationEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ConfigurationSettingName.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ConfigurationSettingName.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ConfigurationSettingName", "Enumeration Members", "previewCustomConfiguration", "reviewMode" ], "headings": [ "Enumeration: ConfigurationSettingName", "Enumeration Members", "previewCustomConfiguration", "reviewMode" ], "name": "Enumeration: ConfigurationSettingName", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ConfigurationSettingName" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ContentComparisonResult.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ContentComparisonResult.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ContentComparisonResult", "Enumeration Members", "NewQueueItem", "NewViewerContent", "NewViewerType", "SameContentNoReload", "SameContentWithReload" ], "headings": [ "Enumeration: ContentComparisonResult", "Enumeration Members", "NewQueueItem", "NewViewerContent", "NewViewerType", "SameContentNoReload", "SameContentWithReload" ], "name": "Enumeration: ContentComparisonResult", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ContentComparisonResult" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ContentType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ContentType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ContentType", "Enumeration Members", "CollectionError", "EmptyQueue", "QueueItem", "UnsupportedItem", "ViewerError" ], "headings": [ "Enumeration: ContentType", "Enumeration Members", "CollectionError", "EmptyQueue", "QueueItem", "UnsupportedItem", "ViewerError" ], "name": "Enumeration: ContentType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ContentType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CustomStatusPillState.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_CustomStatusPillState.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: CustomStatusPillState", "Enumeration Members", "Complete", "Error", "InProgress", "None" ], "headings": [ "Enumeration: CustomStatusPillState", "Enumeration Members", "Complete", "Error", "InProgress", "None" ], "name": "Enumeration: CustomStatusPillState", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: CustomStatusPillState" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_DrawingToolType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_DrawingToolType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: DrawingToolType", "Enumeration Members", "Annotation", "Selection" ], "headings": [ "Enumeration: DrawingToolType", "Enumeration Members", "Annotation", "Selection" ], "name": "Enumeration: DrawingToolType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: DrawingToolType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_DRMFileIdType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_DRMFileIdType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: DRMFileIdType", "Enumeration Members", "FI_DRM_EXCEL", "FI_DRM_EXCEL2007", "FI_DRM_POWERPOINT", "FI_DRM_POWERPOINT2007", "FI_DRM_UNKNOWN", "FI_DRM_WORD", "FI_DRM_WORD2007" ], "headings": [ "Enumeration: DRMFileIdType", "Enumeration Members", "FI_DRM_EXCEL", "FI_DRM_EXCEL2007", "FI_DRM_POWERPOINT", "FI_DRM_POWERPOINT2007", "FI_DRM_UNKNOWN", "FI_DRM_WORD", "FI_DRM_WORD2007" ], "name": "Enumeration: DRMFileIdType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: DRMFileIdType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ErrorCategory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ErrorCategory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ErrorCategory", "Enumeration Members", "ApplicationException", "Network", "Other", "Timeout" ], "headings": [ "Enumeration: ErrorCategory", "Enumeration Members", "ApplicationException", "Network", "Other", "Timeout" ], "name": "Enumeration: ErrorCategory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ErrorCategory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ErrorImageOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ErrorImageOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ErrorImageOptions", "Enumeration Members", "docFailUpdated", "docHelpUpdated", "docMissingUpdated", "docWarning", "docZeroByte", "notesFailedToLoad" ], "headings": [ "Enumeration: ErrorImageOptions", "Enumeration Members", "docFailUpdated", "docHelpUpdated", "docMissingUpdated", "docWarning", "docZeroByte", "notesFailedToLoad" ], "name": "Enumeration: ErrorImageOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ErrorImageOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ErrorSubCategory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ErrorSubCategory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ErrorSubCategory", "Enumeration Members", "ConfigurationError", "FailedToSave", "OutOfSync", "ValidationError" ], "headings": [ "Enumeration: ErrorSubCategory", "Enumeration Members", "ConfigurationError", "FailedToSave", "OutOfSync", "ValidationError" ], "name": "Enumeration: ErrorSubCategory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ErrorSubCategory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ExtensionStatus.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ExtensionStatus.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ExtensionStatus", "Enumeration Members", "Disabled", "Error", "Loaded", "Unloaded" ], "headings": [ "Enumeration: ExtensionStatus", "Enumeration Members", "Disabled", "Error", "Loaded", "Unloaded" ], "name": "Enumeration: ExtensionStatus", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ExtensionStatus" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FileIdType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FileIdType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: FileIdType", "Enumeration Members", "FI_DONTVIEW", "FI_UNKNOWN", "FI_ZEROBYTEFILE" ], "headings": [ "Enumeration: FileIdType", "Enumeration Members", "FI_DONTVIEW", "FI_UNKNOWN", "FI_ZEROBYTEFILE" ], "name": "Enumeration: FileIdType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: FileIdType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FilterType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FilterType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: FilterType", "Enumeration Members", "Conversation", "Date", "DateTime", "Event", "Metadata", "Participant", "Time" ], "headings": [ "Enumeration: FilterType", "Enumeration Members", "Conversation", "Date", "DateTime", "Event", "Metadata", "Participant", "Time" ], "name": "Enumeration: FilterType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: FilterType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FontStyle.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FontStyle.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: FontStyle", "Enumeration Members", "bold", "italic", "normal", "strikeout", "underline" ], "headings": [ "Enumeration: FontStyle", "Enumeration Members", "bold", "italic", "normal", "strikeout", "underline" ], "name": "Enumeration: FontStyle", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: FontStyle" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FontWeight.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_FontWeight.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: FontWeight", "Enumeration Members", "bold", "normal" ], "headings": [ "Enumeration: FontWeight", "Enumeration Members", "bold", "normal" ], "name": "Enumeration: FontWeight", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: FontWeight" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HiddenContentType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HiddenContentType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: HiddenContentType", "Enumeration Members", "LayerOff", "LayerOn" ], "headings": [ "Enumeration: HiddenContentType", "Enumeration Members", "LayerOff", "LayerOn" ], "name": "Enumeration: HiddenContentType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: HiddenContentType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightActivationMode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightActivationMode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: HighlightActivationMode", "Enumeration Members", "box", "disabled", "hatch", "none", "opacity" ], "headings": [ "Enumeration: HighlightActivationMode", "Enumeration Members", "box", "disabled", "hatch", "none", "opacity" ], "name": "Enumeration: HighlightActivationMode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: HighlightActivationMode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightImage.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightImage.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: HighlightImage", "Enumeration Members", "cross", "none" ], "headings": [ "Enumeration: HighlightImage", "Enumeration Members", "cross", "none" ], "name": "Enumeration: HighlightImage", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: HighlightImage" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightServiceEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightServiceEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: HighlightServiceEventType", "Enumeration Members", "PersistentHighlightTermAdded", "RecentSearchSetExpandedStateUpdated", "RecentSearchSetVisibilityUpdated", "RecentSearchTermAdded", "RecentSearchTermCleared", "RecentSearchTermCountUpdated", "RecentSearchTermVisibilityUpdated" ], "headings": [ "Enumeration: HighlightServiceEventType", "Enumeration Members", "PersistentHighlightTermAdded", "RecentSearchSetExpandedStateUpdated", "RecentSearchSetVisibilityUpdated", "RecentSearchTermAdded", "RecentSearchTermCleared", "RecentSearchTermCountUpdated", "RecentSearchTermVisibilityUpdated" ], "name": "Enumeration: HighlightServiceEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: HighlightServiceEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightSubType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_HighlightSubType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: HighlightSubType", "Enumeration Members", "Blue", "Green", "Orange", "Pink", "Purple", "Yellow" ], "headings": [ "Enumeration: HighlightSubType", "Enumeration Members", "Blue", "Green", "Orange", "Pink", "Purple", "Yellow" ], "name": "Enumeration: HighlightSubType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: HighlightSubType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_IExtensionSource.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_IExtensionSource.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: IExtensionSource", "Enumeration Members", "adsApplication", "cloud" ], "headings": [ "Enumeration: IExtensionSource", "Enumeration Members", "adsApplication", "cloud" ], "name": "Enumeration: IExtensionSource", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: IExtensionSource" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ImageViewerEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ImageViewerEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ImageViewerEventType", "Enumeration Members", "AnnotationAdded", "AnnotationDeleted", "AnnotationMoved", "AnnotationSelection", "AnnotationsReloaded", "AnnotationUpdated", "MarkupSetChanged", "RedactionTextSizeChanged" ], "headings": [ "Enumeration: ImageViewerEventType", "Enumeration Members", "AnnotationAdded", "AnnotationDeleted", "AnnotationMoved", "AnnotationSelection", "AnnotationsReloaded", "AnnotationUpdated", "MarkupSetChanged", "RedactionTextSizeChanged" ], "name": "Enumeration: ImageViewerEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ImageViewerEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ImagingServiceEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ImagingServiceEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ImagingServiceEventType", "Enumeration Members", "ImagesDeleted", "ImagingCompleted", "ImagingServiceUpdated", "ImagingStarted", "NewImageUploaded" ], "headings": [ "Enumeration: ImagingServiceEventType", "Enumeration Members", "ImagesDeleted", "ImagingCompleted", "ImagingServiceUpdated", "ImagingStarted", "NewImageUploaded" ], "name": "Enumeration: ImagingServiceEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ImagingServiceEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_InterfaceConfiguration.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_InterfaceConfiguration.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: InterfaceConfiguration", "Enumeration Members", "Embedded", "ExternalStandalone", "Full", "Mobile", "Preview", "ViewerOnly", "ViewerWithToolbar" ], "headings": [ "Enumeration: InterfaceConfiguration", "Enumeration Members", "Embedded", "ExternalStandalone", "Full", "Mobile", "Preview", "ViewerOnly", "ViewerWithToolbar" ], "name": "Enumeration: InterfaceConfiguration", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: InterfaceConfiguration" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_KeyboardShortcutEvents.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_KeyboardShortcutEvents.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: KeyboardShortcutEvents", "Enumeration Members", "mousetrapAdded", "mousetrapRemoved" ], "headings": [ "Enumeration: KeyboardShortcutEvents", "Enumeration Members", "mousetrapAdded", "mousetrapRemoved" ], "name": "Enumeration: KeyboardShortcutEvents", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: KeyboardShortcutEvents" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_LineType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_LineType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: LineType", "Enumeration Members", "dash", "dashdot", "dashdotdot", "dot", "none", "solid" ], "headings": [ "Enumeration: LineType", "Enumeration Members", "dash", "dashdot", "dashdotdot", "dot", "none", "solid" ], "name": "Enumeration: LineType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: LineType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_LongTextViewerEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_LongTextViewerEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: LongTextViewerEventType", "Enumeration Members", "WhitespaceTabWidth" ], "headings": [ "Enumeration: LongTextViewerEventType", "Enumeration Members", "WhitespaceTabWidth" ], "name": "Enumeration: LongTextViewerEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: LongTextViewerEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_NativeServiceEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_NativeServiceEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: NativeServiceEventType", "Enumeration Members", "NewNativeAdded" ], "headings": [ "Enumeration: NativeServiceEventType", "Enumeration Members", "NewNativeAdded" ], "name": "Enumeration: NativeServiceEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: NativeServiceEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_NotificationLevel.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_NotificationLevel.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: NotificationLevel", "Enumeration Members", "Error", "Info", "Success", "Warning" ], "headings": [ "Enumeration: NotificationLevel", "Enumeration Members", "Error", "Info", "Success", "Warning" ], "name": "Enumeration: NotificationLevel", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: NotificationLevel" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_PageLayoutMode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_PageLayoutMode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: PageLayoutMode", "Enumeration Members", "Continuous", "FacingContinuous", "Single" ], "headings": [ "Enumeration: PageLayoutMode", "Enumeration Members", "Continuous", "FacingContinuous", "Single" ], "name": "Enumeration: PageLayoutMode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: PageLayoutMode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_PreloadServiceEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_PreloadServiceEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: PreloadServiceEventType", "Enumeration Members", "ItemsPreloaded", "ItemsPreloading" ], "headings": [ "Enumeration: PreloadServiceEventType", "Enumeration Members", "ItemsPreloaded", "ItemsPreloading" ], "name": "Enumeration: PreloadServiceEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: PreloadServiceEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_PreviewApiEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_PreviewApiEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: PreviewApiEventType", "Enumeration Members", "Popin", "Popout" ], "headings": [ "Enumeration: PreviewApiEventType", "Enumeration Members", "Popin", "Popout" ], "name": "Enumeration: PreviewApiEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: PreviewApiEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ProductionType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ProductionType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ProductionType", "Enumeration Members", "Image", "Native", "PDF", "RedactNative" ], "headings": [ "Enumeration: ProductionType", "Enumeration Members", "Image", "Native", "PDF", "RedactNative" ], "name": "Enumeration: ProductionType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ProductionType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueueEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueueEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: QueueEventType", "Enumeration Members", "AddItemsRequest", "Deleted", "DeleteRequested", "ItemsAdded", "ItemsDeleted", "NameUpdated", "PointerCreated" ], "headings": [ "Enumeration: QueueEventType", "Enumeration Members", "AddItemsRequest", "Deleted", "DeleteRequested", "ItemsAdded", "ItemsDeleted", "NameUpdated", "PointerCreated" ], "name": "Enumeration: QueueEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: QueueEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueuePointerActivationStatus.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueuePointerActivationStatus.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: QueuePointerActivationStatus", "Enumeration Members", "Activated", "Activating", "NotActivated" ], "headings": [ "Enumeration: QueuePointerActivationStatus", "Enumeration Members", "Activated", "Activating", "NotActivated" ], "name": "Enumeration: QueuePointerActivationStatus", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: QueuePointerActivationStatus" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueuePointerEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueuePointerEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: QueuePointerEventType", "Enumeration Members", "Activated", "Deleted", "DeleteRequested", "Shifted", "UpdateApproved", "Updated", "UpdateRequested" ], "headings": [ "Enumeration: QueuePointerEventType", "Enumeration Members", "Activated", "Deleted", "DeleteRequested", "Shifted", "UpdateApproved", "Updated", "UpdateRequested" ], "name": "Enumeration: QueuePointerEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: QueuePointerEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueueServiceEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_QueueServiceEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: QueueServiceEventType", "Enumeration Members", "DeleteQueueRequest", "QueueCreated", "QueueDeleted" ], "headings": [ "Enumeration: QueueServiceEventType", "Enumeration Members", "DeleteQueueRequest", "QueueCreated", "QueueDeleted" ], "name": "Enumeration: QueueServiceEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: QueueServiceEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RectangleEdge.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RectangleEdge.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RectangleEdge", "Enumeration Members", "Bottom", "Left", "Right", "Top" ], "headings": [ "Enumeration: RectangleEdge", "Enumeration Members", "Bottom", "Left", "Right", "Top" ], "name": "Enumeration: RectangleEdge", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RectangleEdge" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RectRangeUnits.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RectRangeUnits.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RectRangeUnits", "Enumeration Members", "pct", "px", "tw" ], "headings": [ "Enumeration: RectRangeUnits", "Enumeration Members", "pct", "px", "tw" ], "name": "Enumeration: RectRangeUnits", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RectRangeUnits" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RedactionMode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RedactionMode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RedactionMode", "Enumeration Members", "Basic", "FullPage", "Inverse", "Mass" ], "headings": [ "Enumeration: RedactionMode", "Enumeration Members", "Basic", "FullPage", "Inverse", "Mass" ], "name": "Enumeration: RedactionMode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RedactionMode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RedactionSubType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RedactionSubType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RedactionSubType", "Enumeration Members", "Black", "Cross", "Inverse", "Text", "White" ], "headings": [ "Enumeration: RedactionSubType", "Enumeration Members", "Black", "Cross", "Inverse", "Text", "White" ], "name": "Enumeration: RedactionSubType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RedactionSubType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativeOrderType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativeOrderType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RelativeOrderType", "Enumeration Members", "aboveEmbeddings", "belowEmbeddings" ], "headings": [ "Enumeration: RelativeOrderType", "Enumeration Members", "aboveEmbeddings", "belowEmbeddings" ], "name": "Enumeration: RelativeOrderType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RelativeOrderType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormCustomButtonActionType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormCustomButtonActionType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RelativityFormCustomButtonActionType", "Enumeration Members", "cancel", "edit", "save", "saveAndBack", "saveAndNext" ], "headings": [ "Enumeration: RelativityFormCustomButtonActionType", "Enumeration Members", "cancel", "edit", "save", "saveAndBack", "saveAndNext" ], "name": "Enumeration: RelativityFormCustomButtonActionType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RelativityFormCustomButtonActionType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormCustomButtonVisibleMode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormCustomButtonVisibleMode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RelativityFormCustomButtonVisibleMode", "Enumeration Members", "add", "edit", "view" ], "headings": [ "Enumeration: RelativityFormCustomButtonVisibleMode", "Enumeration Members", "add", "edit", "view" ], "name": "Enumeration: RelativityFormCustomButtonVisibleMode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RelativityFormCustomButtonVisibleMode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormModelName.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormModelName.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RelativityFormModelName", "Enumeration Members", "edit", "view" ], "headings": [ "Enumeration: RelativityFormModelName", "Enumeration Members", "edit", "view" ], "name": "Enumeration: RelativityFormModelName", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RelativityFormModelName" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormsEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormsEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RelativityFormsEventType", "Enumeration Members", "afterModalClose", "afterSave", "afterSaveAndNext", "apiReady", "beforeModalOpen", "eventHandlerError", "formError", "formReady", "startFormLoad", "startSave" ], "headings": [ "Enumeration: RelativityFormsEventType", "Enumeration Members", "afterModalClose", "afterSave", "afterSaveAndNext", "apiReady", "beforeModalOpen", "eventHandlerError", "formError", "formReady", "startFormLoad", "startSave" ], "name": "Enumeration: RelativityFormsEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RelativityFormsEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormSlotPosition.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityFormSlotPosition.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RelativityFormSlotPosition", "Enumeration Members", "left", "middle", "right" ], "headings": [ "Enumeration: RelativityFormSlotPosition", "Enumeration Members", "left", "middle", "right" ], "name": "Enumeration: RelativityFormSlotPosition", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RelativityFormSlotPosition" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityNativeType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityNativeType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RelativityNativeType", "Enumeration Members", "RelativityShortMessageFormat", "UnknownFormat" ], "headings": [ "Enumeration: RelativityNativeType", "Enumeration Members", "RelativityShortMessageFormat", "UnknownFormat" ], "name": "Enumeration: RelativityNativeType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RelativityNativeType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityQueueItemType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityQueueItemType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RelativityQueueItemType", "Enumeration Members", "Document", "RDOFile", "ShortMessage" ], "headings": [ "Enumeration: RelativityQueueItemType", "Enumeration Members", "Document", "RDOFile", "ShortMessage" ], "name": "Enumeration: RelativityQueueItemType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RelativityQueueItemType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityViewerEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityViewerEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RelativityViewerEventType", "Enumeration Members", "AddComment", "FeaturesInitialized", "FilterDrawerToggle", "FiltersUpdated", "PageChange", "PageCountChange", "Search", "ShowHiddenContent", "ThumbnailDrawerToggle", "TranscriptDocumentLoaded", "TranscriptLoadFailed", "TranscriptViewOpened", "Zoom" ], "headings": [ "Enumeration: RelativityViewerEventType", "Enumeration Members", "AddComment", "FeaturesInitialized", "FilterDrawerToggle", "FiltersUpdated", "PageChange", "PageCountChange", "Search", "ShowHiddenContent", "ThumbnailDrawerToggle", "TranscriptDocumentLoaded", "TranscriptLoadFailed", "TranscriptViewOpened", "Zoom" ], "name": "Enumeration: RelativityViewerEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RelativityViewerEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityViewerType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RelativityViewerType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RelativityViewerType", "Enumeration Members", "Image", "Native", "PDF", "Production", "Text" ], "headings": [ "Enumeration: RelativityViewerType", "Enumeration Members", "Image", "Native", "PDF", "Production", "Text" ], "name": "Enumeration: RelativityViewerType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RelativityViewerType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RenderStatus.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RenderStatus.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RenderStatus", "Enumeration Members", "Complete", "Failed", "InProgress", "NotStarted" ], "headings": [ "Enumeration: RenderStatus", "Enumeration Members", "Complete", "Failed", "InProgress", "NotStarted" ], "name": "Enumeration: RenderStatus", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RenderStatus" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ReviewInterfaceEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ReviewInterfaceEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ReviewInterfaceEventType", "Enumeration Members", "Activated", "ApiReady", "CanDeactivate", "CanTeardown", "Deactivated", "Ready", "Teardown" ], "headings": [ "Enumeration: ReviewInterfaceEventType", "Enumeration Members", "Activated", "ApiReady", "CanDeactivate", "CanTeardown", "Deactivated", "Ready", "Teardown" ], "name": "Enumeration: ReviewInterfaceEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ReviewInterfaceEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ReviewInterfaceWindowEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ReviewInterfaceWindowEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ReviewInterfaceWindowEventType", "Enumeration Members", "ApiReady" ], "headings": [ "Enumeration: ReviewInterfaceWindowEventType", "Enumeration Members", "ApiReady" ], "name": "Enumeration: ReviewInterfaceWindowEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ReviewInterfaceWindowEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ReviewMode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ReviewMode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ReviewMode", "Enumeration Members", "edit", "view" ], "headings": [ "Enumeration: ReviewMode", "Enumeration Members", "edit", "view" ], "name": "Enumeration: ReviewMode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ReviewMode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RwcCopyFromPreviousState.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_RwcCopyFromPreviousState.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: RwcCopyFromPreviousState", "Enumeration Members", "AVAILABLE", "COPIED", "NOTHING_TO_COPY" ], "headings": [ "Enumeration: RwcCopyFromPreviousState", "Enumeration Members", "AVAILABLE", "COPIED", "NOTHING_TO_COPY" ], "name": "Enumeration: RwcCopyFromPreviousState", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: RwcCopyFromPreviousState" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_SizeUnits.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_SizeUnits.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: SizeUnits", "Enumeration Members", "PT", "PX" ], "headings": [ "Enumeration: SizeUnits", "Enumeration Members", "PT", "PX" ], "name": "Enumeration: SizeUnits", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: SizeUnits" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_SkeletonOverlayType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_SkeletonOverlayType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: SkeletonOverlayType", "Enumeration Members", "Generic" ], "headings": [ "Enumeration: SkeletonOverlayType", "Enumeration Members", "Generic" ], "name": "Enumeration: SkeletonOverlayType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: SkeletonOverlayType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_SlicingStatus.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_SlicingStatus.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: SlicingStatus", "Enumeration Members", "Complete", "None", "Slicing" ], "headings": [ "Enumeration: SlicingStatus", "Enumeration Members", "Complete", "None", "Slicing" ], "name": "Enumeration: SlicingStatus", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: SlicingStatus" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_StreamingStatus.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_StreamingStatus.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: StreamingStatus", "Enumeration Members", "Complete", "Error", "None", "Streaming" ], "headings": [ "Enumeration: StreamingStatus", "Enumeration Members", "Complete", "Error", "None", "Streaming" ], "name": "Enumeration: StreamingStatus", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: StreamingStatus" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchDirection.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchDirection.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: TextSearchDirection", "Enumeration Members", "Down", "Up" ], "headings": [ "Enumeration: TextSearchDirection", "Enumeration Members", "Down", "Up" ], "name": "Enumeration: TextSearchDirection", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: TextSearchDirection" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchMode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchMode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: TextSearchMode", "Enumeration Members", "dtsearch", "literal", "literalstar", "strict" ], "headings": [ "Enumeration: TextSearchMode", "Enumeration Members", "dtsearch", "literal", "literalstar", "strict" ], "name": "Enumeration: TextSearchMode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: TextSearchMode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchStemmer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchStemmer.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: TextSearchStemmer", "Enumeration Members", "dtsearch", "none", "porter" ], "headings": [ "Enumeration: TextSearchStemmer", "Enumeration Members", "dtsearch", "none", "porter" ], "name": "Enumeration: TextSearchStemmer", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: TextSearchStemmer" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchUtilityMode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchUtilityMode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: TextSearchUtilityMode", "Enumeration Members", "dtSearch", "Literal", "LiteralStar", "PHSTerms", "String" ], "headings": [ "Enumeration: TextSearchUtilityMode", "Enumeration Members", "dtSearch", "Literal", "LiteralStar", "PHSTerms", "String" ], "name": "Enumeration: TextSearchUtilityMode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: TextSearchUtilityMode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchUtilityStemmer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_TextSearchUtilityStemmer.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: TextSearchUtilityStemmer", "Enumeration Members", "dtSearch", "None", "Porter" ], "headings": [ "Enumeration: TextSearchUtilityStemmer", "Enumeration Members", "dtSearch", "None", "Porter" ], "name": "Enumeration: TextSearchUtilityStemmer", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: TextSearchUtilityStemmer" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ToolbarControlAlignment.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ToolbarControlAlignment.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ToolbarControlAlignment", "Enumeration Members", "Center", "Left", "Right", "RightPermanent" ], "headings": [ "Enumeration: ToolbarControlAlignment", "Enumeration Members", "Center", "Left", "Right", "RightPermanent" ], "name": "Enumeration: ToolbarControlAlignment", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ToolbarControlAlignment" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ToolbarControlType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ToolbarControlType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ToolbarControlType", "Enumeration Members", "Button", "Collection", "Custom", "RWCButton", "RWCToggleButton", "TabCollection" ], "headings": [ "Enumeration: ToolbarControlType", "Enumeration Members", "Button", "Collection", "Custom", "RWCButton", "RWCToggleButton", "TabCollection" ], "name": "Enumeration: ToolbarControlType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ToolbarControlType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ToolTipPosition.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ToolTipPosition.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ToolTipPosition", "Enumeration Members", "Auto", "Bottom", "BottomEnd", "BottomStart", "Left", "LeftEnd", "LeftStart", "Right", "RightEnd", "RightStart", "Top", "TopEnd", "TopStart" ], "headings": [ "Enumeration: ToolTipPosition", "Enumeration Members", "Auto", "Bottom", "BottomEnd", "BottomStart", "Left", "LeftEnd", "LeftStart", "Right", "RightEnd", "RightStart", "Top", "TopEnd", "TopStart" ], "name": "Enumeration: ToolTipPosition", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ToolTipPosition" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerCollectionEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerCollectionEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ViewerCollectionEventType", "Enumeration Members", "ActiveViewerChanged", "BootstrapCompleted", "BootstrapStarted", "ContentChangeApproved", "ContentChanged", "ContentChanging", "DocumentMetaDataChanged", "QueuePointerChanged", "ReloadCompleted", "SkeletonHidden", "SkeletonShown", "ToolbarControlsEnabled", "ViewerActivated", "ViewerDeactivated", "ViewerLoadedItem" ], "headings": [ "Enumeration: ViewerCollectionEventType", "Enumeration Members", "ActiveViewerChanged", "BootstrapCompleted", "BootstrapStarted", "ContentChangeApproved", "ContentChanged", "ContentChanging", "DocumentMetaDataChanged", "QueuePointerChanged", "ReloadCompleted", "SkeletonHidden", "SkeletonShown", "ToolbarControlsEnabled", "ViewerActivated", "ViewerDeactivated", "ViewerLoadedItem" ], "name": "Enumeration: ViewerCollectionEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ViewerCollectionEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerCollectionSkeletonType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerCollectionSkeletonType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ViewerCollectionSkeletonType", "Enumeration Members", "Bootstrap", "Navigation" ], "headings": [ "Enumeration: ViewerCollectionSkeletonType", "Enumeration Members", "Bootstrap", "Navigation" ], "name": "Enumeration: ViewerCollectionSkeletonType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ViewerCollectionSkeletonType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerHighlightEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerHighlightEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ViewerHighlightEventType", "Enumeration Members", "PersistentHighlightCountUpdated", "PersistentHighlightDrawerUpdated", "PersistentHighlightExpandedUpdated", "PersistentHighlightSelectedUpdated", "PersistentHighlightsUpdated", "PersistentHighlightVisibilityUpdated", "RecentSearchSetUpdated" ], "headings": [ "Enumeration: ViewerHighlightEventType", "Enumeration Members", "PersistentHighlightCountUpdated", "PersistentHighlightDrawerUpdated", "PersistentHighlightExpandedUpdated", "PersistentHighlightSelectedUpdated", "PersistentHighlightsUpdated", "PersistentHighlightVisibilityUpdated", "RecentSearchSetUpdated" ], "name": "Enumeration: ViewerHighlightEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ViewerHighlightEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerServiceEventType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerServiceEventType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ViewerServiceEventType", "Enumeration Members", "CollectionCreated", "CollectionDeleted", "DeleteCollectionRequest" ], "headings": [ "Enumeration: ViewerServiceEventType", "Enumeration Members", "CollectionCreated", "CollectionDeleted", "DeleteCollectionRequest" ], "name": "Enumeration: ViewerServiceEventType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ViewerServiceEventType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerZoomLimit.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerZoomLimit.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ViewerZoomLimit", "Enumeration Members", "ZoomDefault", "ZoomMaximum", "ZoomMinimum", "ZoomStep" ], "headings": [ "Enumeration: ViewerZoomLimit", "Enumeration Members", "ZoomDefault", "ZoomMaximum", "ZoomMinimum", "ZoomStep" ], "name": "Enumeration: ViewerZoomLimit", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ViewerZoomLimit" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerZoomMode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_ViewerZoomMode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: ViewerZoomMode", "Enumeration Members", "default", "page", "pageheight", "pagewidth", "percentage" ], "headings": [ "Enumeration: ViewerZoomMode", "Enumeration Members", "default", "page", "pageheight", "pagewidth", "percentage" ], "name": "Enumeration: ViewerZoomMode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: ViewerZoomMode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_VisibilityPersistenceMode.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_VisibilityPersistenceMode.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: VisibilityPersistenceMode", "Enumeration Members", "BrowserSessionStorage", "None" ], "headings": [ "Enumeration: VisibilityPersistenceMode", "Enumeration Members", "BrowserSessionStorage", "None" ], "name": "Enumeration: VisibilityPersistenceMode", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: VisibilityPersistenceMode" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_VisibilityStatusType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Enumeration_VisibilityStatusType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Enumeration: VisibilityStatusType", "Enumeration Members", "Error", "No", "Pending", "Yes" ], "headings": [ "Enumeration: VisibilityStatusType", "Enumeration Members", "Error", "No", "Pending", "Yes" ], "name": "Enumeration: VisibilityStatusType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Enumeration: VisibilityStatusType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Error.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Error.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Error", "Index", "Enumerations", "Interfaces" ], "headings": [ "Error", "Index", "Enumerations", "Interfaces" ], "name": "Error", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Error" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Event.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Event.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Event", "Index", "Interfaces", "Type Aliases" ], "headings": [ "Event", "Index", "Interfaces", "Type Aliases" ], "name": "Event", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Event" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Executing_Custom_Code.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Executing_Custom_Code.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Executing Custom Code", "Custom code execution", "Custom code example", "Available application lifecycle events" ], "headings": [ "Executing Custom Code", "Custom code execution", "Custom code example", "Available application lifecycle events" ], "name": "Executing Custom Code", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Executing Custom Code" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Extension_JavaScript_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Extension_JavaScript_API.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Extension JavaScript API", "Determine whether the Review Extension framework is enabled", "Examine loaded extensions", "Retrieve all loaded extensions", "Retrieve extensions by ID", "Debug extensions via the Extension Debug API", "Temporarily disable the Relativity Review extension framework", "Temporarily disable specific extensions" ], "headings": [ "Extension JavaScript API", "Determine whether the Review Extension framework is enabled", "Examine loaded extensions", "Retrieve all loaded extensions", "Retrieve extensions by ID", "Debug extensions via the Extension Debug API", "Temporarily disable the Relativity Review extension framework", "Temporarily disable specific extensions" ], "name": "Extension JavaScript API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Extension JavaScript API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Extensions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Extensions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Extensions", "Index", "Enumerations", "Interfaces" ], "headings": [ "Extensions", "Index", "Enumerations", "Interfaces" ], "name": "Extensions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Extensions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Extensions_1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Extensions_1.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Extensions", "In this section" ], "headings": [ "Extensions", "In this section" ], "name": "Extensions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Extensions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/FileService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/FileService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "FileService", "Index", "Enumerations", "Interfaces" ], "headings": [ "FileService", "Index", "Enumerations", "Interfaces" ], "name": "FileService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "FileService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Filter.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Filter.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Filter", "Index", "Enumerations", "Interfaces" ], "headings": [ "Filter", "Index", "Enumerations", "Interfaces" ], "name": "Filter", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Filter" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Function_isAsyncExpirationCache__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Function_isAsyncExpirationCache__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Function: isAsyncExpirationCache()", "Type Parameters", "Parameters", "Returns" ], "headings": [ "Function: isAsyncExpirationCache()", "Type Parameters", "Parameters", "Returns" ], "name": "Function: isAsyncExpirationCache()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Function: isAsyncExpirationCache()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Highlight.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Highlight.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Highlight", "Index", "Enumerations", "Interfaces" ], "headings": [ "Highlight", "Index", "Enumerations", "Interfaces" ], "name": "Highlight", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Highlight" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Highlights.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Highlights.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Highlights", "Choosing an approach", "Persistent Highlighting", "Summary" ], "headings": [ "Highlights", "Choosing an approach", "Persistent Highlighting", "Summary" ], "name": "Highlights", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Highlights" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Hyperlink.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Hyperlink.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Hyperlink", "Index", "Interfaces", "Type Aliases" ], "headings": [ "Hyperlink", "Index", "Interfaces", "Type Aliases" ], "name": "Hyperlink", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Hyperlink" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_CellRangeMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_CellRangeMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: CellRangeMemento", "Properties", "c1?", "c2?", "offsets?", "r1?", "r2?", "section?", "sheet?", "type" ], "headings": [ "Interface: CellRangeMemento", "Properties", "c1?", "c2?", "offsets?", "r1?", "r2?", "section?", "sheet?", "type" ], "name": "Interface: CellRangeMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: CellRangeMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ContextMenuItemMap.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ContextMenuItemMap.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ContextMenuItemMap", "Indexable" ], "headings": [ "Interface: ContextMenuItemMap", "Indexable" ], "name": "Interface: ContextMenuItemMap", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ContextMenuItemMap" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_CustomOutsideInViewerOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_CustomOutsideInViewerOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: CustomOutsideInViewerOptions", "Properties", "customStatusPills?", "documentMetricKey?", "enableContextMenu?", "hasHiddenContent?", "hasHighlights?", "hasHighlightSearch?", "hasThumbnails?" ], "headings": [ "Interface: CustomOutsideInViewerOptions", "Properties", "customStatusPills?", "documentMetricKey?", "enableContextMenu?", "hasHiddenContent?", "hasHighlights?", "hasHighlightSearch?", "hasThumbnails?" ], "name": "Interface: CustomOutsideInViewerOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: CustomOutsideInViewerOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_FontSize.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_FontSize.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: FontSize", "Properties", "height", "units" ], "headings": [ "Interface: FontSize", "Properties", "height", "units" ], "name": "Interface: FontSize", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: FontSize" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: HighlightConfig", "Extends", "Properties", "activationMode", "activeStyle?", "allowDelete?", "allowMove?", "allowResize?", "borderColor", "borderLineType", "borderWidth", "cssClass", "enableDelete", "enableMove", "enableResize", "fillColor", "image", "inverse", "label", "labelColor", "labelFontFace", "labelFontSize", "labelFontWeight", "redaction", "relativeOrder?", "reversion", "strokeColor", "textColor", "userData?" ], "headings": [ "Interface: HighlightConfig", "Extends", "Properties", "activationMode", "activeStyle?", "allowDelete?", "allowMove?", "allowResize?", "borderColor", "borderLineType", "borderWidth", "cssClass", "enableDelete", "enableMove", "enableResize", "fillColor", "image", "inverse", "label", "labelColor", "labelFontFace", "labelFontSize", "labelFontWeight", "redaction", "relativeOrder?", "reversion", "strokeColor", "textColor", "userData?" ], "name": "Interface: HighlightConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: HighlightConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: HighlightMemento", "Extends", "Properties", "activationMode?", "activeStyle?", "allowDelete?", "allowMove?", "allowResize?", "borderColor?", "borderLineType?", "borderWidth?", "compound?", "cssClass?", "enableDelete?", "enableMove?", "enableResize?", "fillColor?", "highlightId", "image?", "inverse?", "label?", "labelColor?", "labelFontFace?", "labelFontSize?", "labelFontWeight?", "range", "redaction?", "relativeOrder?", "reversion?", "strokeColor?", "term?", "termContext?", "termMetadata?", "textColor?", "userData?", "visible?" ], "headings": [ "Interface: HighlightMemento", "Extends", "Properties", "activationMode?", "activeStyle?", "allowDelete?", "allowMove?", "allowResize?", "borderColor?", "borderLineType?", "borderWidth?", "compound?", "cssClass?", "enableDelete?", "enableMove?", "enableResize?", "fillColor?", "highlightId", "image?", "inverse?", "label?", "labelColor?", "labelFontFace?", "labelFontSize?", "labelFontWeight?", "range", "redaction?", "relativeOrder?", "reversion?", "strokeColor?", "term?", "termContext?", "termMetadata?", "textColor?", "userData?", "visible?" ], "name": "Interface: HighlightMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: HighlightMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightSetMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightSetMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: HighlightSetMemento", "Properties", "config?", "highlights", "id", "metadata", "terms?", "visible?" ], "headings": [ "Interface: HighlightSetMemento", "Properties", "config?", "highlights", "id", "metadata", "terms?", "visible?" ], "name": "Interface: HighlightSetMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: HighlightSetMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightStyle.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_HighlightStyle.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: HighlightStyle", "Extended by", "Properties", "borderColor", "borderLineType", "borderWidth", "cssClass", "enableDelete", "enableMove", "enableResize", "fillColor", "image", "label", "labelColor", "labelFontFace", "labelFontSize", "labelFontWeight", "strokeColor", "textColor" ], "headings": [ "Interface: HighlightStyle", "Extended by", "Properties", "borderColor", "borderLineType", "borderWidth", "cssClass", "enableDelete", "enableMove", "enableResize", "fillColor", "image", "label", "labelColor", "labelFontFace", "labelFontSize", "labelFontWeight", "strokeColor", "textColor" ], "name": "Interface: HighlightStyle", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: HighlightStyle" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IActiveViewerChangedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IActiveViewerChangedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IActiveViewerChangedEvent", "Properties", "currentType", "targetType" ], "headings": [ "Interface: IActiveViewerChangedEvent", "Properties", "currentType", "targetType" ], "name": "Interface: IActiveViewerChangedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IActiveViewerChangedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAddItemsRequestEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAddItemsRequestEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAddItemsRequestEvent", "Properties", "index", "items" ], "headings": [ "Interface: IAddItemsRequestEvent", "Properties", "index", "items" ], "name": "Interface: IAddItemsRequestEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAddItemsRequestEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAddPersistentHighlightTermsToSetRequest.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAddPersistentHighlightTermsToSetRequest.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAddPersistentHighlightTermsToSetRequest", "Properties", "backgroundColor?", "foregroundColor?", "term" ], "headings": [ "Interface: IAddPersistentHighlightTermsToSetRequest", "Properties", "backgroundColor?", "foregroundColor?", "term" ], "name": "Interface: IAddPersistentHighlightTermsToSetRequest", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAddPersistentHighlightTermsToSetRequest" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotation.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotation.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAnnotation", "Properties", "createdOn?", "customAnnotationData?", "guid", "height", "imageHeight", "imageWidth", "markupId", "markupSet", "oiHighlightId?", "pageHeight", "pageNumber", "pageWidth", "subType", "textData?", "type", "width", "xCoordinate", "yCoordinate" ], "headings": [ "Interface: IAnnotation", "Properties", "createdOn?", "customAnnotationData?", "guid", "height", "imageHeight", "imageWidth", "markupId", "markupSet", "oiHighlightId?", "pageHeight", "pageNumber", "pageWidth", "subType", "textData?", "type", "width", "xCoordinate", "yCoordinate" ], "name": "Interface: IAnnotation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAnnotation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationChangedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationChangedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAnnotationChangedEvent", "Properties", "annotationsChanged" ], "headings": [ "Interface: IAnnotationChangedEvent", "Properties", "annotationsChanged" ], "name": "Interface: IAnnotationChangedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAnnotationChangedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationDetailsData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationDetailsData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAnnotationDetailsData", "Properties", "Height?", "HeightDeltaOldAndNewValue", "HeightOldAndNewValue", "MarkupSetArtifactId", "PageNumber", "Width?", "WidthDeltaOldAndNewValue", "WidthOldAndNewValue", "X?", "XDeltaOldAndNewValue", "XOldAndNewValue", "Y?", "YDeltaOldAndNewValue", "YOldAndNewValue" ], "headings": [ "Interface: IAnnotationDetailsData", "Properties", "Height?", "HeightDeltaOldAndNewValue", "HeightOldAndNewValue", "MarkupSetArtifactId", "PageNumber", "Width?", "WidthDeltaOldAndNewValue", "WidthOldAndNewValue", "X?", "XDeltaOldAndNewValue", "XOldAndNewValue", "Y?", "YDeltaOldAndNewValue", "YOldAndNewValue" ], "name": "Interface: IAnnotationDetailsData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAnnotationDetailsData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationHistoryData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationHistoryData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAnnotationHistoryData", "Properties", "Action", "ActionName", "ArtifactId", "Details", "TimeStamp", "UserId", "UserName" ], "headings": [ "Interface: IAnnotationHistoryData", "Properties", "Action", "ActionName", "ArtifactId", "Details", "TimeStamp", "UserId", "UserName" ], "name": "Interface: IAnnotationHistoryData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAnnotationHistoryData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationLookup.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationLookup.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAnnotationLookup", "Indexable" ], "headings": [ "Interface: IAnnotationLookup", "Indexable" ], "name": "Interface: IAnnotationLookup", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAnnotationLookup" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationOldAndNewValue.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationOldAndNewValue.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAnnotationOldAndNewValue", "Properties", "NewValue?", "OldValue?" ], "headings": [ "Interface: IAnnotationOldAndNewValue", "Properties", "NewValue?", "OldValue?" ], "name": "Interface: IAnnotationOldAndNewValue", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAnnotationOldAndNewValue" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationRectangle.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationRectangle.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAnnotationRectangle", "Properties", "height", "width", "x", "y" ], "headings": [ "Interface: IAnnotationRectangle", "Properties", "height", "width", "x", "y" ], "name": "Interface: IAnnotationRectangle", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAnnotationRectangle" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationSelectionEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationSelectionEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAnnotationSelectionEvent", "Properties", "selectedAnnotations" ], "headings": [ "Interface: IAnnotationSelectionEvent", "Properties", "selectedAnnotations" ], "name": "Interface: IAnnotationSelectionEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAnnotationSelectionEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationsService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAnnotationsService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAnnotationsService", "Methods", "getAnnotationHistory()", "getAnnotationVisibility()", "getAnnotationVisibilityFromSession()", "getDefaultMarkupSetData()", "getMarkupSetAnnotations()", "getMarkupSetData()", "getUserDefaultRedactionText()", "getUserDefaultRedactionTextSize()", "persistNewMarkupSetSelection()", "setAnnotationVisibility()", "setUserDefaultRedactionText()", "setUserDefaultRedactionTextSize()" ], "headings": [ "Interface: IAnnotationsService", "Methods", "getAnnotationHistory()", "getAnnotationVisibility()", "getAnnotationVisibilityFromSession()", "getDefaultMarkupSetData()", "getMarkupSetAnnotations()", "getMarkupSetData()", "getUserDefaultRedactionText()", "getUserDefaultRedactionTextSize()", "persistNewMarkupSetSelection()", "setAnnotationVisibility()", "setUserDefaultRedactionText()", "setUserDefaultRedactionTextSize()" ], "name": "Interface: IAnnotationsService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAnnotationsService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IApplicationLifecycleService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IApplicationLifecycleService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IApplicationLifecycleService", "Properties", "isActivated", "Methods", "activate()", "canDeactivate()", "deactivate()", "exitReviewInterface()", "exitToRelativityUrl()", "returnToDocumentList()", "setExitViewerLocation()", "setIsActiveOverride()" ], "headings": [ "Interface: IApplicationLifecycleService", "Properties", "isActivated", "Methods", "activate()", "canDeactivate()", "deactivate()", "exitReviewInterface()", "exitToRelativityUrl()", "returnToDocumentList()", "setExitViewerLocation()", "setIsActiveOverride()" ], "name": "Interface: IApplicationLifecycleService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IApplicationLifecycleService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IApplicationWindow.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IApplicationWindow.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IApplicationWindow", "Extends", "Properties", "isMain", "isOpen", "isRelativityWindow", "name", "window?", "Methods", "close()", "off()", "on()", "once()" ], "headings": [ "Interface: IApplicationWindow", "Extends", "Properties", "isMain", "isOpen", "isRelativityWindow", "name", "window?", "Methods", "close()", "off()", "on()", "once()" ], "name": "Interface: IApplicationWindow", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IApplicationWindow" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IApplicationWindowConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IApplicationWindowConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IApplicationWindowConfig", "Properties", "autoFocus?", "features?", "isPopup?", "name", "title?", "url?" ], "headings": [ "Interface: IApplicationWindowConfig", "Properties", "autoFocus?", "features?", "isPopup?", "name", "title?", "url?" ], "name": "Interface: IApplicationWindowConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IApplicationWindowConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAsyncExpirationCacheT.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAsyncExpirationCacheT.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAsyncExpirationCache\u0026lt;T\u0026gt;", "Type Parameters", "Properties", "isAsyncCache", "Methods", "addOrUpdate()", "get()", "has()", "howOld()", "tryRemove()", "updateMaxSize()" ], "headings": [ "Interface: IAsyncExpirationCache\u0026lt;T\u0026gt;", "Type Parameters", "Properties", "isAsyncCache", "Methods", "addOrUpdate()", "get()", "has()", "howOld()", "tryRemove()", "updateMaxSize()" ], "name": "Interface: IAsyncExpirationCache\u0026lt;T\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAsyncExpirationCache\u0026lt;T\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAuditObjectManagerData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAuditObjectManagerData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAuditObjectManagerData", "Properties", "CurrentStartIndex", "Objects?", "ObjectType", "ResultCount", "TotalCount" ], "headings": [ "Interface: IAuditObjectManagerData", "Properties", "CurrentStartIndex", "Objects?", "ObjectType", "ResultCount", "TotalCount" ], "name": "Interface: IAuditObjectManagerData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAuditObjectManagerData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAuditObjectsEntity.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAuditObjectsEntity.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAuditObjectsEntity", "Properties", "ArtifactID", "FieldValues", "Guids?", "Name" ], "headings": [ "Interface: IAuditObjectsEntity", "Properties", "ArtifactID", "FieldValues", "Guids?", "Name" ], "name": "Interface: IAuditObjectsEntity", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAuditObjectsEntity" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAuditQueryOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IAuditQueryOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IAuditQueryOptions", "Properties", "ReturnRawDetails?" ], "headings": [ "Interface: IAuditQueryOptions", "Properties", "ReturnRawDetails?" ], "name": "Interface: IAuditQueryOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IAuditQueryOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IBatchService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IBatchService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IBatchService", "Methods", "getBatchesByDocument()" ], "headings": [ "Interface: IBatchService", "Methods", "getBatchesByDocument()" ], "name": "Interface: IBatchService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IBatchService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICacheK__V.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICacheK__V.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICache\u0026lt;K, V\u0026gt;", "Type Parameters", "Methods", "clear()", "delete()", "get()", "has()", "set()" ], "headings": [ "Interface: ICache\u0026lt;K, V\u0026gt;", "Type Parameters", "Methods", "clear()", "delete()", "get()", "has()", "set()" ], "name": "Interface: ICache\u0026lt;K, V\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICache\u0026lt;K, V\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICancellationToken.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICancellationToken.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICancellationToken", "Properties", "isCancellationRequested", "Methods", "offCancellation()", "onCancellation()", "throwIfCancellationRequested()" ], "headings": [ "Interface: ICancellationToken", "Properties", "isCancellationRequested", "Methods", "offCancellation()", "onCancellation()", "throwIfCancellationRequested()" ], "name": "Interface: ICancellationToken", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICancellationToken" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICard.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICard.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICard", "Extended by", "Properties", "active", "activeFlag", "applicationWindow", "autoRestore", "bottomToolbar?", "cardError", "config", "defaultHeight?", "defaultWidth?", "dockSkeletonClassName", "element?", "enabled", "errorString?", "frame?", "hasError", "hasNotification", "height?", "icon", "id", "instance?", "instanceId", "instanceIndex", "leftToolbar?", "loadDeferred", "location?", "maximized", "minHeight", "minWidth", "order", "overlay?", "parameters?", "popoutInProgress", "poppedIn", "poppedOut", "rightToolbar?", "skeletonVisible", "status", "title", "toolbars?", "topToolbar?", "visible", "width?", "window", "Methods", "activate()", "bindInstance()", "canDeactivate()", "completeFrameLoad()", "createBanner()", "createHtmlBanner()", "createToolbar()", "deactivate()", "disable()", "dismissBanner()", "dismissBannerByClass()", "enable()", "failFrameLoad()", "hideOverlay()", "hideSkeleton()", "load()", "maximize()", "move()", "popin()", "popout()", "remove()", "reportError()", "restore()", "resumeMinHeight()", "setActiveFlag()", "setStatus()", "showNotificationDot()", "showOverlay()", "showSkeleton()", "stateChanged()", "suspendMinHeight()", "unload()", "updateLayout()", "waitForDetachment()" ], "headings": [ "Interface: ICard", "Extended by", "Properties", "active", "activeFlag", "applicationWindow", "autoRestore", "bottomToolbar?", "cardError", "config", "defaultHeight?", "defaultWidth?", "dockSkeletonClassName", "element?", "enabled", "errorString?", "frame?", "hasError", "hasNotification", "height?", "icon", "id", "instance?", "instanceId", "instanceIndex", "leftToolbar?", "loadDeferred", "location?", "maximized", "minHeight", "minWidth", "order", "overlay?", "parameters?", "popoutInProgress", "poppedIn", "poppedOut", "rightToolbar?", "skeletonVisible", "status", "title", "toolbars?", "topToolbar?", "visible", "width?", "window", "Methods", "activate()", "bindInstance()", "canDeactivate()", "completeFrameLoad()", "createBanner()", "createHtmlBanner()", "createToolbar()", "deactivate()", "disable()", "dismissBanner()", "dismissBannerByClass()", "enable()", "failFrameLoad()", "hideOverlay()", "hideSkeleton()", "load()", "maximize()", "move()", "popin()", "popout()", "remove()", "reportError()", "restore()", "resumeMinHeight()", "setActiveFlag()", "setStatus()", "showNotificationDot()", "showOverlay()", "showSkeleton()", "stateChanged()", "suspendMinHeight()", "unload()", "updateLayout()", "waitForDetachment()" ], "name": "Interface: ICard", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICard" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardBanner.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardBanner.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardBanner", "Extended by", "Properties", "bannerClass", "card", "dismissed", "type", "Methods", "dismiss()" ], "headings": [ "Interface: ICardBanner", "Extended by", "Properties", "bannerClass", "card", "dismissed", "type", "Methods", "dismiss()" ], "name": "Interface: ICardBanner", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardBanner" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardBannerConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardBannerConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardBannerConfig", "Extended by", "Properties", "bannerClass?" ], "headings": [ "Interface: ICardBannerConfig", "Extended by", "Properties", "bannerClass?" ], "name": "Interface: ICardBannerConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardBannerConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardConfig", "Extended by", "Properties", "appGuid?", "appVersion?", "autoRestore?", "category?", "categoryOrder?", "createInstance()?", "defaultHeight?", "defaultWidth?", "extends?", "icon?", "id", "loader", "location?", "minHeight?", "minWidth?", "order?", "singleton?", "skeleton?", "supportsPopout?", "title", "toolbarsConfig?", "toolTipConfig?" ], "headings": [ "Interface: ICardConfig", "Extended by", "Properties", "appGuid?", "appVersion?", "autoRestore?", "category?", "categoryOrder?", "createInstance()?", "defaultHeight?", "defaultWidth?", "extends?", "icon?", "id", "loader", "location?", "minHeight?", "minWidth?", "order?", "singleton?", "skeleton?", "supportsPopout?", "title", "toolbarsConfig?", "toolTipConfig?" ], "name": "Interface: ICardConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardError.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardError.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardError", "Properties", "category?", "isFatal", "stack?", "subCategory?" ], "headings": [ "Interface: ICardError", "Properties", "category?", "isFatal", "stack?", "subCategory?" ], "name": "Interface: ICardError", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardError" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardIcon.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardIcon.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardIcon", "Properties", "class?", "fileName?", "svgIcon?", "url?" ], "headings": [ "Interface: ICardIcon", "Properties", "class?", "fileName?", "svgIcon?", "url?" ], "name": "Interface: ICardIcon", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardIcon" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardInstance.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardInstance.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardInstance", "Extended by", "Properties", "cardActivated()?", "cardCanDeactivate()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?" ], "headings": [ "Interface: ICardInstance", "Extended by", "Properties", "cardActivated()?", "cardCanDeactivate()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?" ], "name": "Interface: ICardInstance", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardInstance" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardLoaderConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardLoaderConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardLoaderConfig", "Properties", "custom?", "iframe?", "viewmodel?" ], "headings": [ "Interface: ICardLoaderConfig", "Properties", "custom?", "iframe?", "viewmodel?" ], "name": "Interface: ICardLoaderConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardLoaderConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardLocation.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardLocation.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardLocation", "Properties", "dockIndex?", "layoutId?", "layoutInstance?", "paneId" ], "headings": [ "Interface: ICardLocation", "Properties", "dockIndex?", "layoutId?", "layoutInstance?", "paneId" ], "name": "Interface: ICardLocation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardLocation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardService", "Methods", "createCard()", "defineCard()", "destroyCard()", "getCard()" ], "headings": [ "Interface: ICardService", "Methods", "createCard()", "defineCard()", "destroyCard()", "getCard()" ], "name": "Interface: ICardService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardSkeleton.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardSkeleton.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardSkeleton", "Properties", "delay?", "hideSkeleton()", "minimum?", "showSkeleton()" ], "headings": [ "Interface: ICardSkeleton", "Properties", "delay?", "hideSkeleton()", "minimum?", "showSkeleton()" ], "name": "Interface: ICardSkeleton", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardSkeleton" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardToolbarConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICardToolbarConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICardToolbarConfig", "Properties", "class?", "edge", "id?", "title?" ], "headings": [ "Interface: ICardToolbarConfig", "Properties", "class?", "edge", "id?", "title?" ], "name": "Interface: ICardToolbarConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICardToolbarConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICodingCard.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICodingCard.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICodingCard", "Extends", "Properties", "buttons", "cardActivated()?", "cardCanDeactivate()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?", "isEditMode", "isLoaded", "Methods", "addButton()", "applyCopyFromPreviousAsync()", "cancelAsync()", "editAsync()", "getConvenienceAPI()", "getRelativityFormsEnvelope()", "removeButton()", "saveAndBackAsync()", "saveAndNextAsync()", "saveAsync()" ], "headings": [ "Interface: ICodingCard", "Extends", "Properties", "buttons", "cardActivated()?", "cardCanDeactivate()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?", "isEditMode", "isLoaded", "Methods", "addButton()", "applyCopyFromPreviousAsync()", "cancelAsync()", "editAsync()", "getConvenienceAPI()", "getRelativityFormsEnvelope()", "removeButton()", "saveAndBackAsync()", "saveAndNextAsync()", "saveAsync()" ], "name": "Interface: ICodingCard", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICodingCard" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICollectionCreatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICollectionCreatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICollectionCreatedEvent", "Properties", "collection" ], "headings": [ "Interface: ICollectionCreatedEvent", "Properties", "collection" ], "name": "Interface: ICollectionCreatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICollectionCreatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICollectionDeletedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICollectionDeletedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICollectionDeletedEvent", "Properties", "collection" ], "headings": [ "Interface: ICollectionDeletedEvent", "Properties", "collection" ], "name": "Interface: ICollectionDeletedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICollectionDeletedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IColor.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IColor.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IColor", "Properties", "A", "B", "G", "R", "Methods", "getRGBAString()" ], "headings": [ "Interface: IColor", "Properties", "A", "B", "G", "R", "Methods", "getRGBAString()" ], "name": "Interface: IColor", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IColor" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConfigurationChangedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConfigurationChangedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IConfigurationChangedEvent", "Properties", "newValue", "oldValue", "settingName" ], "headings": [ "Interface: IConfigurationChangedEvent", "Properties", "newValue", "oldValue", "settingName" ], "name": "Interface: IConfigurationChangedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IConfigurationChangedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConfigurationOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConfigurationOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IConfigurationOptions", "Properties", "developerMode?", "elementId", "embeddedContextKey?", "embeddedFeatureConfig?", "enabledViewerTypes?", "enableUrlRouting?", "initializeFoundationCore?", "instanceSettings", "interfaceConfiguration?", "monitoring?", "performanceReportOptions", "relativity", "reviewMode?", "signalRTransportMethod", "staticContentPath?", "testingMode?" ], "headings": [ "Interface: IConfigurationOptions", "Properties", "developerMode?", "elementId", "embeddedContextKey?", "embeddedFeatureConfig?", "enabledViewerTypes?", "enableUrlRouting?", "initializeFoundationCore?", "instanceSettings", "interfaceConfiguration?", "monitoring?", "performanceReportOptions", "relativity", "reviewMode?", "signalRTransportMethod", "staticContentPath?", "testingMode?" ], "name": "Interface: IConfigurationOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IConfigurationOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConfigurationService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConfigurationService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IConfigurationService", "Extends", "Properties", "reviewMode", "workspaceId", "Methods", "off()", "on()", "once()", "updateSetting()" ], "headings": [ "Interface: IConfigurationService", "Extends", "Properties", "reviewMode", "workspaceId", "Methods", "off()", "on()", "once()", "updateSetting()" ], "name": "Interface: IConfigurationService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IConfigurationService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentChangeApprovedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentChangeApprovedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentChangeApprovedEvent", "Properties", "currentType", "targetType" ], "headings": [ "Interface: IContentChangeApprovedEvent", "Properties", "currentType", "targetType" ], "name": "Interface: IContentChangeApprovedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentChangeApprovedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentChangedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentChangedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentChangedEvent", "Properties", "contentType", "documentMetric?", "item?", "reloadRequired?", "viewerType?" ], "headings": [ "Interface: IContentChangedEvent", "Properties", "contentType", "documentMetric?", "item?", "reloadRequired?", "viewerType?" ], "name": "Interface: IContentChangedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentChangedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentChangingEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentChangingEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentChangingEvent", "Properties", "item", "viewerType" ], "headings": [ "Interface: IContentChangingEvent", "Properties", "item", "viewerType" ], "name": "Interface: IContentChangingEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentChangingEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentComparison.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentComparison.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentComparison", "Properties", "isNewProduction", "isNewProductionType", "isNewQueueItem", "isNewTextField", "isNewTransform", "isNewViewerContent", "isNewViewerType", "isSameContent", "result" ], "headings": [ "Interface: IContentComparison", "Properties", "isNewProduction", "isNewProductionType", "isNewQueueItem", "isNewTextField", "isNewTransform", "isNewViewerContent", "isNewViewerType", "isSameContent", "result" ], "name": "Interface: IContentComparison", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentComparison" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentDescriptionQueueItemType__TransformQueueItemType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentDescriptionQueueItemType__TransformQueueItemType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentDescription\u0026lt;QueueItemType, TransformQueueItemType\u0026gt;", "Type Parameters", "Properties", "item?", "type", "viewerOptions?", "viewerType?" ], "headings": [ "Interface: IContentDescription\u0026lt;QueueItemType, TransformQueueItemType\u0026gt;", "Type Parameters", "Properties", "item?", "type", "viewerOptions?", "viewerType?" ], "name": "Interface: IContentDescription\u0026lt;QueueItemType, TransformQueueItemType\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentDescription\u0026lt;QueueItemType, TransformQueueItemType\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightActiveChangeEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightActiveChangeEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiHighlightActiveChangeEvent", "Properties", "highlights" ], "headings": [ "Interface: IContentHighlightApiHighlightActiveChangeEvent", "Properties", "highlights" ], "name": "Interface: IContentHighlightApiHighlightActiveChangeEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiHighlightActiveChangeEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightAddEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightAddEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiHighlightAddEvent", "Properties", "highlights", "highlightSet" ], "headings": [ "Interface: IContentHighlightApiHighlightAddEvent", "Properties", "highlights", "highlightSet" ], "name": "Interface: IContentHighlightApiHighlightAddEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiHighlightAddEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightClickEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightClickEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiHighlightClickEvent", "Properties", "active", "highlight" ], "headings": [ "Interface: IContentHighlightApiHighlightClickEvent", "Properties", "active", "highlight" ], "name": "Interface: IContentHighlightApiHighlightClickEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiHighlightClickEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightMoveEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightMoveEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiHighlightMoveEvent", "Properties", "highlight", "highlightSet", "oldRange" ], "headings": [ "Interface: IContentHighlightApiHighlightMoveEvent", "Properties", "highlight", "highlightSet", "oldRange" ], "name": "Interface: IContentHighlightApiHighlightMoveEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiHighlightMoveEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightRemoveEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiHighlightRemoveEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiHighlightRemoveEvent", "Properties", "highlights", "highlightSet" ], "headings": [ "Interface: IContentHighlightApiHighlightRemoveEvent", "Properties", "highlights", "highlightSet" ], "name": "Interface: IContentHighlightApiHighlightRemoveEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiHighlightRemoveEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSearchCompleteEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSearchCompleteEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiSearchCompleteEvent", "Properties", "highlightSet" ], "headings": [ "Interface: IContentHighlightApiSearchCompleteEvent", "Properties", "highlightSet" ], "name": "Interface: IContentHighlightApiSearchCompleteEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiSearchCompleteEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSearchEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSearchEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiSearchEvent", "Properties", "highlightSet", "isFirstTerm", "term", "termContext?" ], "headings": [ "Interface: IContentHighlightApiSearchEvent", "Properties", "highlightSet", "isFirstTerm", "term", "termContext?" ], "name": "Interface: IContentHighlightApiSearchEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiSearchEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSetAddEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSetAddEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiSetAddEvent", "Properties", "highlightSet", "isTermHighlightSet", "term?", "termContext?" ], "headings": [ "Interface: IContentHighlightApiSetAddEvent", "Properties", "highlightSet", "isTermHighlightSet", "term?", "termContext?" ], "name": "Interface: IContentHighlightApiSetAddEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiSetAddEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSetRemoveEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSetRemoveEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiSetRemoveEvent", "Properties", "highlightSet" ], "headings": [ "Interface: IContentHighlightApiSetRemoveEvent", "Properties", "highlightSet" ], "name": "Interface: IContentHighlightApiSetRemoveEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiSetRemoveEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSetVisibleChangeEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiSetVisibleChangeEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiSetVisibleChangeEvent", "Properties", "highlightSet", "visible" ], "headings": [ "Interface: IContentHighlightApiSetVisibleChangeEvent", "Properties", "highlightSet", "visible" ], "name": "Interface: IContentHighlightApiSetVisibleChangeEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiSetVisibleChangeEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiVisibleChangeEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightApiVisibleChangeEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightApiVisibleChangeEvent", "Properties", "visible" ], "headings": [ "Interface: IContentHighlightApiVisibleChangeEvent", "Properties", "visible" ], "name": "Interface: IContentHighlightApiVisibleChangeEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightApiVisibleChangeEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingApi", "Extends", "Properties", "visible", "Methods", "addHighlight()", "addHighlightTooltip()", "addTerm()", "addTermWithContext()", "addToSetGroup()", "createSet()", "createSetGroup()", "deleteSetGroup()", "deselectAllAnnotations()", "disableAutoHighlight()", "doesSetExist()", "emit()", "enableAutoHighlight()", "getHighlights()", "getSelectedAnnotations()", "getSetGroups()", "getSets()", "goToFirst()", "goToHighlight()", "goToLast()", "goToNext()", "goToPrev()", "hide()", "highlightTerm()", "highlightTermWithContext()", "isTermHighlightingInProgress()", "off()", "offhighlightactivechange()", "offhighlightadd()", "offhighlightclick()", "offhighlightmove()", "offhighlightremove()", "offsearch()", "offsearchcomplete()", "offsetadd()", "offsetremove()", "offsetvisiblechange()", "offvisiblechange()", "on()", "onhighlightactivechange()", "onhighlightadd()", "onhighlightclick()", "onhighlightmove()", "onhighlightremove()", "onsearch()", "onsearchcomplete()", "onsetadd()", "onsetremove()", "onsetvisiblechange()", "onvisiblechange()", "removeFromSetGroup()", "removeHighlight()", "removeHighlightSet()", "removeHighlightTooltip()", "selectAnnotation()", "serialize()", "setAllHighlightSetsVisibility()", "setGroupVisibility()", "setHighlightSetVisibility()", "setHighlightVisibility()", "setVisibility()", "show()", "toggleHighlightSetVisibility()", "toggleHighlightVisibility()", "toggleVisibility()", "waitForTermHighlightingToComplete()" ], "headings": [ "Interface: IContentHighlightingApi", "Extends", "Properties", "visible", "Methods", "addHighlight()", "addHighlightTooltip()", "addTerm()", "addTermWithContext()", "addToSetGroup()", "createSet()", "createSetGroup()", "deleteSetGroup()", "deselectAllAnnotations()", "disableAutoHighlight()", "doesSetExist()", "emit()", "enableAutoHighlight()", "getHighlights()", "getSelectedAnnotations()", "getSetGroups()", "getSets()", "goToFirst()", "goToHighlight()", "goToLast()", "goToNext()", "goToPrev()", "hide()", "highlightTerm()", "highlightTermWithContext()", "isTermHighlightingInProgress()", "off()", "offhighlightactivechange()", "offhighlightadd()", "offhighlightclick()", "offhighlightmove()", "offhighlightremove()", "offsearch()", "offsearchcomplete()", "offsetadd()", "offsetremove()", "offsetvisiblechange()", "offvisiblechange()", "on()", "onhighlightactivechange()", "onhighlightadd()", "onhighlightclick()", "onhighlightmove()", "onhighlightremove()", "onsearch()", "onsearchcomplete()", "onsetadd()", "onsetremove()", "onsetvisiblechange()", "onvisiblechange()", "removeFromSetGroup()", "removeHighlight()", "removeHighlightSet()", "removeHighlightTooltip()", "selectAnnotation()", "serialize()", "setAllHighlightSetsVisibility()", "setGroupVisibility()", "setHighlightSetVisibility()", "setHighlightVisibility()", "setVisibility()", "show()", "toggleHighlightSetVisibility()", "toggleHighlightVisibility()", "toggleVisibility()", "waitForTermHighlightingToComplete()" ], "name": "Interface: IContentHighlightingApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingCardApi", "Properties", "feature", "supportedViewerTypes", "viewerCollection", "visible", "Methods", "getContentDescription()", "getHighlightingApi()", "getRenderStatus()", "hide()", "offcontent()", "offrender()", "offrenderabort()", "offrendercomplete()", "offrendererror()", "offvisiblechange()", "oncontent()", "onrender()", "onrenderabort()", "onrendercomplete()", "onrendererror()", "onvisiblechange()", "reload()", "setVisible()", "show()", "toggleVisible()" ], "headings": [ "Interface: IContentHighlightingCardApi", "Properties", "feature", "supportedViewerTypes", "viewerCollection", "visible", "Methods", "getContentDescription()", "getHighlightingApi()", "getRenderStatus()", "hide()", "offcontent()", "offrender()", "offrenderabort()", "offrendercomplete()", "offrendererror()", "offvisiblechange()", "oncontent()", "onrender()", "onrenderabort()", "onrendercomplete()", "onrendererror()", "onvisiblechange()", "reload()", "setVisible()", "show()", "toggleVisible()" ], "name": "Interface: IContentHighlightingCardApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingCardApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiContentChangeEventCType__CTType__PCType__PCTType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiContentChangeEventCType__CTType__PCType__PCTType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingCardApiContentChangeEvent\u0026lt;CType, CTType, PCType, PCTType\u0026gt;", "Type Parameters", "Properties", "abort?", "api", "comparison", "content", "documentMetric", "highlightingApi?", "previousContent?" ], "headings": [ "Interface: IContentHighlightingCardApiContentChangeEvent\u0026lt;CType, CTType, PCType, PCTType\u0026gt;", "Type Parameters", "Properties", "abort?", "api", "comparison", "content", "documentMetric", "highlightingApi?", "previousContent?" ], "name": "Interface: IContentHighlightingCardApiContentChangeEvent\u0026lt;CType, CTType, PCType, PCTType\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingCardApiContentChangeEvent\u0026lt;CType, CTType, PCType, PCTType\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderAbortEventCType__CTType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderAbortEventCType__CTType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingCardApiRenderAbortEvent\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Properties", "abort", "api", "content", "highlightingApi?", "viewerType" ], "headings": [ "Interface: IContentHighlightingCardApiRenderAbortEvent\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Properties", "abort", "api", "content", "highlightingApi?", "viewerType" ], "name": "Interface: IContentHighlightingCardApiRenderAbortEvent\u0026lt;CType, CTType\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingCardApiRenderAbortEvent\u0026lt;CType, CTType\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderCompleteEventCType__CTType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderCompleteEventCType__CTType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingCardApiRenderCompleteEvent\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Properties", "abort", "api", "content", "highlightingApi?", "viewerType" ], "headings": [ "Interface: IContentHighlightingCardApiRenderCompleteEvent\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Properties", "abort", "api", "content", "highlightingApi?", "viewerType" ], "name": "Interface: IContentHighlightingCardApiRenderCompleteEvent\u0026lt;CType, CTType\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingCardApiRenderCompleteEvent\u0026lt;CType, CTType\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderErrorEventCType__CTType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderErrorEventCType__CTType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingCardApiRenderErrorEvent\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Properties", "abort", "api", "content", "error", "highlightingApi?", "viewerType" ], "headings": [ "Interface: IContentHighlightingCardApiRenderErrorEvent\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Properties", "abort", "api", "content", "error", "highlightingApi?", "viewerType" ], "name": "Interface: IContentHighlightingCardApiRenderErrorEvent\u0026lt;CType, CTType\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingCardApiRenderErrorEvent\u0026lt;CType, CTType\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderEventCType__CTType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiRenderEventCType__CTType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingCardApiRenderEvent\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Properties", "abort", "api", "content", "highlightingApi?", "viewerType" ], "headings": [ "Interface: IContentHighlightingCardApiRenderEvent\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Properties", "abort", "api", "content", "highlightingApi?", "viewerType" ], "name": "Interface: IContentHighlightingCardApiRenderEvent\u0026lt;CType, CTType\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingCardApiRenderEvent\u0026lt;CType, CTType\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiVisibleChangeEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardApiVisibleChangeEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingCardApiVisibleChangeEvent", "Properties", "api", "visible" ], "headings": [ "Interface: IContentHighlightingCardApiVisibleChangeEvent", "Properties", "api", "visible" ], "name": "Interface: IContentHighlightingCardApiVisibleChangeEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingCardApiVisibleChangeEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardVisibleFnParametersCType__CTType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingCardVisibleFnParametersCType__CTType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingCardVisibleFnParameters\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Properties", "api", "content", "viewerCollection" ], "headings": [ "Interface: IContentHighlightingCardVisibleFnParameters\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Properties", "api", "content", "viewerCollection" ], "name": "Interface: IContentHighlightingCardVisibleFnParameters\u0026lt;CType, CTType\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingCardVisibleFnParameters\u0026lt;CType, CTType\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingFeature.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingFeature.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingFeature", "Properties", "applicationGuid?", "config", "extensionId?", "id", "order", "priority" ], "headings": [ "Interface: IContentHighlightingFeature", "Properties", "applicationGuid?", "config", "extensionId?", "id", "order", "priority" ], "name": "Interface: IContentHighlightingFeature", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingFeature" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingFeatureConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingFeatureConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingFeatureConfig", "Properties", "cardId?", "cardVisibleFn?", "enabled?", "id", "name", "order?", "renderFn", "supportedViewerTypes?", "visibleByDefault?" ], "headings": [ "Interface: IContentHighlightingFeatureConfig", "Properties", "cardId?", "cardVisibleFn?", "enabled?", "id", "name", "order?", "renderFn", "supportedViewerTypes?", "visibleByDefault?" ], "name": "Interface: IContentHighlightingFeatureConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingFeatureConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingManager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingManager.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingManager", "Properties", "initialized", "viewerCollection", "Methods", "getCard()", "getCardApi()", "getFeatureVisible()", "getHighlightingApi()", "getRenderStatus()", "hideFeature()", "reload()", "setFeatureVisible()", "showFeature()", "toggleFeatureVisible()" ], "headings": [ "Interface: IContentHighlightingManager", "Properties", "initialized", "viewerCollection", "Methods", "getCard()", "getCardApi()", "getFeatureVisible()", "getHighlightingApi()", "getRenderStatus()", "hideFeature()", "reload()", "setFeatureVisible()", "showFeature()", "toggleFeatureVisible()" ], "name": "Interface: IContentHighlightingManager", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingManager" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingRenderStatus.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingRenderStatus.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingRenderStatus", "Properties", "error?", "status" ], "headings": [ "Interface: IContentHighlightingRenderStatus", "Properties", "error?", "status" ], "name": "Interface: IContentHighlightingRenderStatus", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingRenderStatus" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingService", "Properties", "enabled", "features", "Methods", "disable()", "disableFeature()", "enable()", "enableFeature()", "getFeature()", "getFeatureEnabled()", "offenabledchange()", "offfeatureenabledchange()", "offfeatureregistered()", "onenabledchange()", "onfeatureenabledchange()", "onfeatureregistered()", "setEnabled()", "setFeatureEnabled()", "toggleEnabled()", "toggleFeatureEnabled()" ], "headings": [ "Interface: IContentHighlightingService", "Properties", "enabled", "features", "Methods", "disable()", "disableFeature()", "enable()", "enableFeature()", "getFeature()", "getFeatureEnabled()", "offenabledchange()", "offfeatureenabledchange()", "offfeatureregistered()", "onenabledchange()", "onfeatureenabledchange()", "onfeatureregistered()", "setEnabled()", "setFeatureEnabled()", "toggleEnabled()", "toggleFeatureEnabled()" ], "name": "Interface: IContentHighlightingService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingServiceEnabledChangeEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingServiceEnabledChangeEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingServiceEnabledChangeEvent", "Properties", "enabled" ], "headings": [ "Interface: IContentHighlightingServiceEnabledChangeEvent", "Properties", "enabled" ], "name": "Interface: IContentHighlightingServiceEnabledChangeEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingServiceEnabledChangeEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingServiceFeatureEnabledChangeEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingServiceFeatureEnabledChangeEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingServiceFeatureEnabledChangeEvent", "Properties", "enabled", "feature" ], "headings": [ "Interface: IContentHighlightingServiceFeatureEnabledChangeEvent", "Properties", "enabled", "feature" ], "name": "Interface: IContentHighlightingServiceFeatureEnabledChangeEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingServiceFeatureEnabledChangeEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingServiceFeatureRegisteredEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContentHighlightingServiceFeatureRegisteredEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContentHighlightingServiceFeatureRegisteredEvent", "Properties", "feature" ], "headings": [ "Interface: IContentHighlightingServiceFeatureRegisteredEvent", "Properties", "feature" ], "name": "Interface: IContentHighlightingServiceFeatureRegisteredEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContentHighlightingServiceFeatureRegisteredEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContext.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContext.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContext", "Indexable" ], "headings": [ "Interface: IContext", "Indexable" ], "name": "Interface: IContext", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContext" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenu.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenu.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContextMenu", "Properties", "enabled", "parentElementId", "Methods", "addItem()", "addItemConfig()", "disable()", "enable()", "getItem()", "itemExists()", "items()", "removeAll()", "removeItem()" ], "headings": [ "Interface: IContextMenu", "Properties", "enabled", "parentElementId", "Methods", "addItem()", "addItemConfig()", "disable()", "enable()", "getItem()", "itemExists()", "items()", "removeAll()", "removeItem()" ], "name": "Interface: IContextMenu", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContextMenu" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuFactory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuFactory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContextMenuFactory", "Methods", "createContextMenu()", "createContextMenuById()", "createContextMenuItem()", "createContextMenuItemFromConfig()", "getContextMenu()", "getContextMenuById()", "removeContextMenu()", "removeContextMenuById()" ], "headings": [ "Interface: IContextMenuFactory", "Methods", "createContextMenu()", "createContextMenuById()", "createContextMenuItem()", "createContextMenuItemFromConfig()", "getContextMenu()", "getContextMenuById()", "removeContextMenu()", "removeContextMenuById()" ], "name": "Interface: IContextMenuFactory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContextMenuFactory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuItem.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuItem.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContextMenuItem", "Properties", "childItems", "disabled", "icon", "onBuildCallback()", "onClickCallback()", "order", "permissionCheck?", "rwcIcon?", "rwcIconClass?", "rwcIconColor?", "text", "visible", "Methods", "deepCopy()", "getOptions()" ], "headings": [ "Interface: IContextMenuItem", "Properties", "childItems", "disabled", "icon", "onBuildCallback()", "onClickCallback()", "order", "permissionCheck?", "rwcIcon?", "rwcIconClass?", "rwcIconColor?", "text", "visible", "Methods", "deepCopy()", "getOptions()" ], "name": "Interface: IContextMenuItem", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContextMenuItem" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuItemConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuItemConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContextMenuItemConfig", "Properties", "childItems?", "disabled?", "icon?", "onBuildCallback()?", "onClickCallback()?", "order?", "permissionCheck?", "rwcIcon?", "rwcIconClass?", "rwcIconColor?", "text", "visible?" ], "headings": [ "Interface: IContextMenuItemConfig", "Properties", "childItems?", "disabled?", "icon?", "onBuildCallback()?", "onClickCallback()?", "order?", "permissionCheck?", "rwcIcon?", "rwcIconClass?", "rwcIconColor?", "text", "visible?" ], "name": "Interface: IContextMenuItemConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContextMenuItemConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuNativeFileData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuNativeFileData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContextMenuNativeFileData", "Properties", "fileTypeId", "relativityNativeType" ], "headings": [ "Interface: IContextMenuNativeFileData", "Properties", "fileTypeId", "relativityNativeType" ], "name": "Interface: IContextMenuNativeFileData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContextMenuNativeFileData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuQueueItemData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuQueueItemData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContextMenuQueueItemData", "Properties", "item?", "nativeData?" ], "headings": [ "Interface: IContextMenuQueueItemData", "Properties", "item?", "nativeData?" ], "name": "Interface: IContextMenuQueueItemData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContextMenuQueueItemData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuReviewData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IContextMenuReviewData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IContextMenuReviewData", "Properties", "cursor", "queueItemData?", "queuePointer", "workspaceId", "Methods", "exists()", "get()", "getAnnotationsAtCursor()", "getSelectedAnnotations()", "getSelectedText()", "getSelection()", "getViewerObjectsAtCursor()", "set()" ], "headings": [ "Interface: IContextMenuReviewData", "Properties", "cursor", "queueItemData?", "queuePointer", "workspaceId", "Methods", "exists()", "get()", "getAnnotationsAtCursor()", "getSelectedAnnotations()", "getSelectedText()", "getSelection()", "getViewerObjectsAtCursor()", "set()" ], "name": "Interface: IContextMenuReviewData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IContextMenuReviewData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IControlCollection.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IControlCollection.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IControlCollection", "Extends", "Extended by", "Properties", "ariaLabel?", "class", "controls", "disabled", "id", "isControlCollection", "isFlexible", "isHidden", "leftDivider", "order", "permissionCheck?", "rightDivider", "role?", "scrollDimensions", "title", "viewModelPath", "Methods", "addControl()", "disable()", "enable()", "getControlById()", "hide()", "removeControl()", "show()" ], "headings": [ "Interface: IControlCollection", "Extends", "Extended by", "Properties", "ariaLabel?", "class", "controls", "disabled", "id", "isControlCollection", "isFlexible", "isHidden", "leftDivider", "order", "permissionCheck?", "rightDivider", "role?", "scrollDimensions", "title", "viewModelPath", "Methods", "addControl()", "disable()", "enable()", "getControlById()", "hide()", "removeControl()", "show()" ], "name": "Interface: IControlCollection", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IControlCollection" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConvenienceApiService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IConvenienceApiService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IConvenienceApiService", "Methods", "get()" ], "headings": [ "Interface: IConvenienceApiService", "Methods", "get()" ], "name": "Interface: IConvenienceApiService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IConvenienceApiService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICreateAnnotationOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICreateAnnotationOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICreateAnnotationOptions", "Properties", "persist?", "text?", "textSize?" ], "headings": [ "Interface: ICreateAnnotationOptions", "Properties", "persist?", "text?", "textSize?" ], "name": "Interface: ICreateAnnotationOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICreateAnnotationOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICreateDocumentActionOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICreateDocumentActionOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICreateDocumentActionOptions", "Properties", "sectionIcon?" ], "headings": [ "Interface: ICreateDocumentActionOptions", "Properties", "sectionIcon?" ], "name": "Interface: ICreateDocumentActionOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICreateDocumentActionOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomAnnotationData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomAnnotationData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICustomAnnotationData", "Properties", "borderColor?", "borderSize?", "borderStyle?", "fillColor?" ], "headings": [ "Interface: ICustomAnnotationData", "Properties", "borderColor?", "borderSize?", "borderStyle?", "fillColor?" ], "name": "Interface: ICustomAnnotationData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICustomAnnotationData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomCardLoader.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomCardLoader.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICustomCardLoader", "Properties", "loadCard()", "unloadCard()" ], "headings": [ "Interface: ICustomCardLoader", "Properties", "loadCard()", "unloadCard()" ], "name": "Interface: ICustomCardLoader", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICustomCardLoader" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomControl.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomControl.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICustomControl", "Extends", "Properties", "ariaLabel?", "class", "disabled", "id", "innerHTML", "isControlCollection", "isFlexible", "isHidden", "order", "permissionCheck?", "role?", "scrollDimensions", "title", "viewModelPath", "Methods", "disable()", "enable()", "hide()", "show()" ], "headings": [ "Interface: ICustomControl", "Extends", "Properties", "ariaLabel?", "class", "disabled", "id", "innerHTML", "isControlCollection", "isFlexible", "isHidden", "order", "permissionCheck?", "role?", "scrollDimensions", "title", "viewModelPath", "Methods", "disable()", "enable()", "hide()", "show()" ], "name": "Interface: ICustomControl", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICustomControl" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICustomData", "Indexable" ], "headings": [ "Interface: ICustomData", "Indexable" ], "name": "Interface: ICustomData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICustomData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomStatusPillConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ICustomStatusPillConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ICustomStatusPillConfig", "Properties", "errorMessage?", "inProgressMessage?", "name", "successMessage?" ], "headings": [ "Interface: ICustomStatusPillConfig", "Properties", "errorMessage?", "inProgressMessage?", "name", "successMessage?" ], "name": "Interface: ICustomStatusPillConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ICustomStatusPillConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDeleteCollectionRequestEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDeleteCollectionRequestEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IDeleteCollectionRequestEvent", "Properties", "collection" ], "headings": [ "Interface: IDeleteCollectionRequestEvent", "Properties", "collection" ], "name": "Interface: IDeleteCollectionRequestEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IDeleteCollectionRequestEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDeleteQueueRequestEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDeleteQueueRequestEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IDeleteQueueRequestEvent", "Properties", "queue" ], "headings": [ "Interface: IDeleteQueueRequestEvent", "Properties", "queue" ], "name": "Interface: IDeleteQueueRequestEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IDeleteQueueRequestEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentActionCollection.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentActionCollection.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IDocumentActionCollection", "Methods", "addDocumentAction()", "createDocumentAction()", "disable()", "enable()", "getDocumentAction()", "removeDocumentAction()" ], "headings": [ "Interface: IDocumentActionCollection", "Methods", "addDocumentAction()", "createDocumentAction()", "disable()", "enable()", "getDocumentAction()", "removeDocumentAction()" ], "name": "Interface: IDocumentActionCollection", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IDocumentActionCollection" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentActionControl.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentActionControl.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IDocumentActionControl", "Extends", "Properties", "ariaLabel?", "class", "disabled", "documentActionCollection", "id", "isControlCollection", "isFlexible", "isHidden", "order", "permissionCheck?", "role?", "scrollDimensions", "title", "viewModelPath", "Methods", "disable()", "enable()", "handleAction()", "handleVCUpdate()", "hide()", "show()", "updateVisible()" ], "headings": [ "Interface: IDocumentActionControl", "Extends", "Properties", "ariaLabel?", "class", "disabled", "documentActionCollection", "id", "isControlCollection", "isFlexible", "isHidden", "order", "permissionCheck?", "role?", "scrollDimensions", "title", "viewModelPath", "Methods", "disable()", "enable()", "handleAction()", "handleVCUpdate()", "hide()", "show()", "updateVisible()" ], "name": "Interface: IDocumentActionControl", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IDocumentActionControl" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentDataCacheManager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentDataCacheManager.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IDocumentDataCacheManager", "Methods", "tryClearCache()", "tryClearCacheForQueueItem()" ], "headings": [ "Interface: IDocumentDataCacheManager", "Methods", "tryClearCache()", "tryClearCacheForQueueItem()" ], "name": "Interface: IDocumentDataCacheManager", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IDocumentDataCacheManager" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentHistoryService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentHistoryService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IDocumentHistoryService", "Methods", "getDocumentHistory()", "getDocumentHistorySlim()" ], "headings": [ "Interface: IDocumentHistoryService", "Methods", "getDocumentHistory()", "getDocumentHistorySlim()" ], "name": "Interface: IDocumentHistoryService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IDocumentHistoryService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentItem.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentItem.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IDocumentItem", "Extends", "Properties", "artifactId", "extension", "id", "itemIdentifier", "itemTransforms?", "label", "type" ], "headings": [ "Interface: IDocumentItem", "Extends", "Properties", "artifactId", "extension", "id", "itemIdentifier", "itemTransforms?", "label", "type" ], "name": "Interface: IDocumentItem", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IDocumentItem" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentItemIdentifier.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentItemIdentifier.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IDocumentItemIdentifier", "Extends", "Properties", "artifactId", "id?" ], "headings": [ "Interface: IDocumentItemIdentifier", "Extends", "Properties", "artifactId", "id?" ], "name": "Interface: IDocumentItemIdentifier", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IDocumentItemIdentifier" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentListCardService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentListCardService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IDocumentListCardService", "Methods", "setView()" ], "headings": [ "Interface: IDocumentListCardService", "Methods", "setView()" ], "name": "Interface: IDocumentListCardService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IDocumentListCardService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentObjectManagerData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IDocumentObjectManagerData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IDocumentObjectManagerData", "Properties", "CurrentStartIndex", "Fields?", "Objects?", "ObjectType", "ResultCount", "TotalCount" ], "headings": [ "Interface: IDocumentObjectManagerData", "Properties", "CurrentStartIndex", "Fields?", "Objects?", "ObjectType", "ResultCount", "TotalCount" ], "name": "Interface: IDocumentObjectManagerData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IDocumentObjectManagerData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IEmbeddedFeatureConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IEmbeddedFeatureConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IEmbeddedFeatureConfig", "Indexable", "Properties", "contextMenu?", "extensions?", "httpWarningBanner?", "oi.viewer.searchPill?", "previewApi?" ], "headings": [ "Interface: IEmbeddedFeatureConfig", "Indexable", "Properties", "contextMenu?", "extensions?", "httpWarningBanner?", "oi.viewer.searchPill?", "previewApi?" ], "name": "Interface: IEmbeddedFeatureConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IEmbeddedFeatureConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IErrorDisplayOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IErrorDisplayOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IErrorDisplayOptions", "Properties", "backgroundColor?", "imageFileName?", "linkInformation?", "parentElement?", "parentElementId?", "retryHandler()?" ], "headings": [ "Interface: IErrorDisplayOptions", "Properties", "backgroundColor?", "imageFileName?", "linkInformation?", "parentElement?", "parentElementId?", "retryHandler()?" ], "name": "Interface: IErrorDisplayOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IErrorDisplayOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IErrorLinkInformation.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IErrorLinkInformation.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IErrorLinkInformation", "Properties", "link", "onclick()?", "target", "text" ], "headings": [ "Interface: IErrorLinkInformation", "Properties", "link", "onclick()?", "target", "text" ], "name": "Interface: IErrorLinkInformation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IErrorLinkInformation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IErrorService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IErrorService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IErrorService", "Methods", "cleanupFullScreenError()", "cleanupFullScreenErrorById()", "cleanupHangingFullScreenErrors()", "displayConfigurableFullScreenError()", "displayFullScreenError()", "displayFullScreenErrorById()" ], "headings": [ "Interface: IErrorService", "Methods", "cleanupFullScreenError()", "cleanupFullScreenErrorById()", "cleanupHangingFullScreenErrors()", "displayConfigurableFullScreenError()", "displayFullScreenError()", "displayFullScreenErrorById()" ], "name": "Interface: IErrorService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IErrorService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IEventEmitterT.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IEventEmitterT.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IEventEmitter\u0026lt;T\u0026gt;", "Type Param", "Extended by", "Type Parameters", "Methods", "off()", "on()", "once()" ], "headings": [ "Interface: IEventEmitter\u0026lt;T\u0026gt;", "Type Param", "Extended by", "Type Parameters", "Methods", "off()", "on()", "once()" ], "name": "Interface: IEventEmitter\u0026lt;T\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IEventEmitter\u0026lt;T\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExpirationCacheT.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExpirationCacheT.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExpirationCache\u0026lt;T\u0026gt;", "Type Parameters", "Methods", "addOrUpdate()", "get()", "has()", "howOld()", "tryRemove()", "updateMaxSize()" ], "headings": [ "Interface: IExpirationCache\u0026lt;T\u0026gt;", "Type Parameters", "Methods", "addOrUpdate()", "get()", "has()", "howOld()", "tryRemove()", "updateMaxSize()" ], "name": "Interface: IExpirationCache\u0026lt;T\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExpirationCache\u0026lt;T\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtendsConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtendsConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtendsConfig", "Properties", "options?", "type" ], "headings": [ "Interface: IExtendsConfig", "Properties", "options?", "type" ], "name": "Interface: IExtendsConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtendsConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtension.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtension.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtension", "Properties", "applicationGuid", "applicationName", "config", "error?", "fileName", "metrics", "status", "version" ], "headings": [ "Interface: IExtension", "Properties", "applicationGuid", "applicationName", "config", "error?", "fileName", "metrics", "status", "version" ], "name": "Interface: IExtension", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtension" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionApi", "Properties", "all", "debug", "enabled", "Methods", "getById()" ], "headings": [ "Interface: IExtensionApi", "Properties", "all", "debug", "enabled", "Methods", "getById()" ], "name": "Interface: IExtensionApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionApplication.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionApplication.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionApplication", "Properties", "appName", "extensions", "guid", "name" ], "headings": [ "Interface: IExtensionApplication", "Properties", "appName", "extensions", "guid", "name" ], "name": "Interface: IExtensionApplication", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionApplication" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionCollection.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionCollection.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionCollection", "Indexable" ], "headings": [ "Interface: IExtensionCollection", "Indexable" ], "name": "Interface: IExtensionCollection", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionCollection" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionComponent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionComponent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionComponent", "Properties", "class?", "id", "previous?", "text?" ], "headings": [ "Interface: IExtensionComponent", "Properties", "class?", "id", "previous?", "text?" ], "name": "Interface: IExtensionComponent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionComponent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionConfig", "Properties", "cards?", "contentHighlighting?", "id", "isEnabled()?", "itemListFieldValueTransforms?", "itemLoadTransforms?", "lifecycle?", "name", "rtcMessageHandlers?", "smartHighlights?", "viewerCollectionFooterControls()?", "viewerContextMenus()?", "viewers?", "viewerToolbarControls()?" ], "headings": [ "Interface: IExtensionConfig", "Properties", "cards?", "contentHighlighting?", "id", "isEnabled()?", "itemListFieldValueTransforms?", "itemLoadTransforms?", "lifecycle?", "name", "rtcMessageHandlers?", "smartHighlights?", "viewerCollectionFooterControls()?", "viewerContextMenus()?", "viewers?", "viewerToolbarControls()?" ], "name": "Interface: IExtensionConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionConfig_1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionConfig_1.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionConfig", "Properties", "cards?", "contentHighlighting?", "id", "isEnabled()?", "itemListFieldValueTransforms?", "itemLoadTransforms?", "lifecycle?", "name", "rtcMessageHandlers?", "smartHighlights?", "viewerCollectionFooterControls()?", "viewerContextMenus()?", "viewers?", "viewerToolbarControls()?" ], "headings": [ "Interface: IExtensionConfig", "Properties", "cards?", "contentHighlighting?", "id", "isEnabled()?", "itemListFieldValueTransforms?", "itemLoadTransforms?", "lifecycle?", "name", "rtcMessageHandlers?", "smartHighlights?", "viewerCollectionFooterControls()?", "viewerContextMenus()?", "viewers?", "viewerToolbarControls()?" ], "name": "Interface: IExtensionConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionConfigurationSettings.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionConfigurationSettings.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionConfigurationSettings", "Properties", "reviewMode", "workspaceId" ], "headings": [ "Interface: IExtensionConfigurationSettings", "Properties", "reviewMode", "workspaceId" ], "name": "Interface: IExtensionConfigurationSettings", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionConfigurationSettings" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionDebugApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionDebugApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionDebugApi", "Methods", "disableById()", "disableExtensionFramework()", "enableAll()", "enableById()", "enableExtensionFramework()" ], "headings": [ "Interface: IExtensionDebugApi", "Methods", "disableById()", "disableExtensionFramework()", "enableAll()", "enableById()", "enableExtensionFramework()" ], "name": "Interface: IExtensionDebugApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionDebugApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionDetails.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionDetails.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionDetails", "Properties", "source" ], "headings": [ "Interface: IExtensionDetails", "Properties", "source" ], "name": "Interface: IExtensionDetails", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionDetails" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionDetails_1.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionDetails_1.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionDetails", "Properties", "source" ], "headings": [ "Interface: IExtensionDetails", "Properties", "source" ], "name": "Interface: IExtensionDetails", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionDetails" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionFeatureOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionFeatureOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionFeatureOptions", "Properties", "filter()?" ], "headings": [ "Interface: IExtensionFeatureOptions", "Properties", "filter()?" ], "name": "Interface: IExtensionFeatureOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionFeatureOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionFilterDetails.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionFilterDetails.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionFilterDetails", "Properties", "applicationGuid?", "extensionId?" ], "headings": [ "Interface: IExtensionFilterDetails", "Properties", "applicationGuid?", "extensionId?" ], "name": "Interface: IExtensionFilterDetails", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionFilterDetails" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionLifecycle.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionLifecycle.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionLifecycle", "Properties", "activated()?", "apiready()?", "canDeactivate()?", "canTeardown()?", "deactivated()?", "ready()?", "teardown()?" ], "headings": [ "Interface: IExtensionLifecycle", "Properties", "activated()?", "apiready()?", "canDeactivate()?", "canTeardown()?", "deactivated()?", "ready()?", "teardown()?" ], "name": "Interface: IExtensionLifecycle", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionLifecycle" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionMetrics.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionMetrics.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionMetrics", "Indexable" ], "headings": [ "Interface: IExtensionMetrics", "Indexable" ], "name": "Interface: IExtensionMetrics", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionMetrics" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionParameters.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IExtensionParameters.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IExtensionParameters", "Properties", "applicationContext", "configuration", "embeddedContextKey?", "extensionDetails", "foundationInstance?", "getResourceFileUrl()", "getResourceUrl()", "relativityTenantContext", "version" ], "headings": [ "Interface: IExtensionParameters", "Properties", "applicationContext", "configuration", "embeddedContextKey?", "extensionDetails", "foundationInstance?", "getResourceFileUrl()", "getResourceUrl()", "relativityTenantContext", "version" ], "name": "Interface: IExtensionParameters", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IExtensionParameters" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFeaturesInitializedEventData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFeaturesInitializedEventData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IFeaturesInitializedEventData", "Properties", "viewerType" ], "headings": [ "Interface: IFeaturesInitializedEventData", "Properties", "viewerType" ], "name": "Interface: IFeaturesInitializedEventData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IFeaturesInitializedEventData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFieldIdentifier.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFieldIdentifier.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IFieldIdentifier", "Properties", "ArtifactId?", "Guid?", "Name?" ], "headings": [ "Interface: IFieldIdentifier", "Properties", "ArtifactId?", "Guid?", "Name?" ], "name": "Interface: IFieldIdentifier", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IFieldIdentifier" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFieldsEntity.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFieldsEntity.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IFieldsEntity", "Properties", "ArtifactID", "FieldCategory", "FieldType", "Guids?", "Name", "ViewFieldID" ], "headings": [ "Interface: IFieldsEntity", "Properties", "ArtifactID", "FieldCategory", "FieldType", "Guids?", "Name", "ViewFieldID" ], "name": "Interface: IFieldsEntity", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IFieldsEntity" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFieldValuesEntity.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFieldValuesEntity.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IFieldValuesEntity", "Properties", "Field", "Value" ], "headings": [ "Interface: IFieldValuesEntity", "Properties", "Field", "Value" ], "name": "Interface: IFieldValuesEntity", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IFieldValuesEntity" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFileService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFileService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IFileService", "Properties", "imaging", "native" ], "headings": [ "Interface: IFileService", "Properties", "imaging", "native" ], "name": "Interface: IFileService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IFileService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFilterGroup.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFilterGroup.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IFilterGroup", "Properties", "filterType", "groupName", "isDate", "isDateTime", "isTime", "order", "Methods", "deepCopy()" ], "headings": [ "Interface: IFilterGroup", "Properties", "filterType", "groupName", "isDate", "isDateTime", "isTime", "order", "Methods", "deepCopy()" ], "name": "Interface: IFilterGroup", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IFilterGroup" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFilterOption.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFilterOption.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IFilterOption", "Properties", "active", "filterType", "id", "locked", "messageCount", "option", "Methods", "deepCopy()" ], "headings": [ "Interface: IFilterOption", "Properties", "active", "filterType", "id", "locked", "messageCount", "option", "Methods", "deepCopy()" ], "name": "Interface: IFilterOption", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IFilterOption" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFiltersUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IFiltersUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IFiltersUpdatedEvent", "Properties", "filterGroups" ], "headings": [ "Interface: IFiltersUpdatedEvent", "Properties", "filterGroups" ], "name": "Interface: IFiltersUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IFiltersUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHeaders.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHeaders.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHeaders", "Methods", "add()", "clear()", "get()", "has()" ], "headings": [ "Interface: IHeaders", "Methods", "add()", "clear()", "get()", "has()" ], "name": "Interface: IHeaders", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHeaders" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightListenerActive__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightListenerActive__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHighlightListenerActive()", "Parameters", "Returns" ], "headings": [ "Interface: IHighlightListenerActive()", "Parameters", "Returns" ], "name": "Interface: IHighlightListenerActive()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHighlightListenerActive()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightListenerClick__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightListenerClick__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHighlightListenerClick()", "Parameters", "Returns" ], "headings": [ "Interface: IHighlightListenerClick()", "Parameters", "Returns" ], "name": "Interface: IHighlightListenerClick()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHighlightListenerClick()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightListenerVisibility__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightListenerVisibility__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHighlightListenerVisibility()", "Parameters", "Returns" ], "headings": [ "Interface: IHighlightListenerVisibility()", "Parameters", "Returns" ], "name": "Interface: IHighlightListenerVisibility()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHighlightListenerVisibility()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHighlightService", "Methods", "addTerms()", "clearNewHighlightStyling()", "clearRecentSearchTerm()", "clearRecentSearchTerms()", "getAllHighlightData()", "getPersistentHighlightSetData()", "getRecentSearchSetData()", "setActiveViewer()", "setRecentSearchTerm()" ], "headings": [ "Interface: IHighlightService", "Methods", "addTerms()", "clearNewHighlightStyling()", "clearRecentSearchTerm()", "clearRecentSearchTerms()", "getAllHighlightData()", "getPersistentHighlightSetData()", "getRecentSearchSetData()", "setActiveViewer()", "setRecentSearchTerm()" ], "name": "Interface: IHighlightService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHighlightService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerAdd__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerAdd__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHighlightSetListenerAdd()", "Parameters", "Returns" ], "headings": [ "Interface: IHighlightSetListenerAdd()", "Parameters", "Returns" ], "name": "Interface: IHighlightSetListenerAdd()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHighlightSetListenerAdd()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerDone__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerDone__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHighlightSetListenerDone()", "Parameters", "Returns" ], "headings": [ "Interface: IHighlightSetListenerDone()", "Parameters", "Returns" ], "name": "Interface: IHighlightSetListenerDone()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHighlightSetListenerDone()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerMove__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerMove__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHighlightSetListenerMove()", "Parameters", "Returns" ], "headings": [ "Interface: IHighlightSetListenerMove()", "Parameters", "Returns" ], "name": "Interface: IHighlightSetListenerMove()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHighlightSetListenerMove()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerRemove__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightSetListenerRemove__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHighlightSetListenerRemove()", "Parameters", "Returns" ], "headings": [ "Interface: IHighlightSetListenerRemove()", "Parameters", "Returns" ], "name": "Interface: IHighlightSetListenerRemove()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHighlightSetListenerRemove()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightViewer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHighlightViewer.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHighlightViewer", "Extends", "Extended by", "Properties", "highlights", "shouldHighlight", "Methods", "off()", "on()", "once()" ], "headings": [ "Interface: IHighlightViewer", "Extends", "Extended by", "Properties", "highlights", "shouldHighlight", "Methods", "off()", "on()", "once()" ], "name": "Interface: IHighlightViewer", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHighlightViewer" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHtmlCardBanner.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHtmlCardBanner.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHtmlCardBanner", "Extends", "Properties", "bannerClass", "card", "dismissed", "element?", "type", "Methods", "dismiss()", "onRender()" ], "headings": [ "Interface: IHtmlCardBanner", "Extends", "Properties", "bannerClass", "card", "dismissed", "element?", "type", "Methods", "dismiss()", "onRender()" ], "name": "Interface: IHtmlCardBanner", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHtmlCardBanner" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHtmlCardBannerConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHtmlCardBannerConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHtmlCardBannerConfig", "Extends", "Properties", "bannerClass?", "onrender()?" ], "headings": [ "Interface: IHtmlCardBannerConfig", "Extends", "Properties", "bannerClass?", "onrender()?" ], "name": "Interface: IHtmlCardBannerConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHtmlCardBannerConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHttpClient.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHttpClient.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHttpClient", "Methods", "get()", "post()", "put()" ], "headings": [ "Interface: IHttpClient", "Methods", "get()", "post()", "put()" ], "name": "Interface: IHttpClient", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHttpClient" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHttpResponseMessage.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHttpResponseMessage.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHttpResponseMessage", "Properties", "content", "headers", "isSuccess", "mimeType", "requestMessage", "response", "responseType", "reviver()", "statusCode", "statusText" ], "headings": [ "Interface: IHttpResponseMessage", "Properties", "content", "headers", "isSuccess", "mimeType", "requestMessage", "response", "responseType", "reviver()", "statusCode", "statusText" ], "name": "Interface: IHttpResponseMessage", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHttpResponseMessage" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHyperlink.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHyperlink.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHyperlink", "Properties", "alt?", "artifactId?", "external", "id", "manuallyAdded", "name?", "range?", "target?", "type", "url", "userData" ], "headings": [ "Interface: IHyperlink", "Properties", "alt?", "artifactId?", "external", "id", "manuallyAdded", "name?", "range?", "target?", "type", "url", "userData" ], "name": "Interface: IHyperlink", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHyperlink" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHyperlinkManagerApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHyperlinkManagerApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHyperlinkManagerApi", "Remarks", "Methods", "activate()", "add()", "forPage()", "forRange()", "remove()" ], "headings": [ "Interface: IHyperlinkManagerApi", "Remarks", "Methods", "activate()", "add()", "forPage()", "forRange()", "remove()" ], "name": "Interface: IHyperlinkManagerApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHyperlinkManagerApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHyperlinkManagerEventApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IHyperlinkManagerEventApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IHyperlinkManagerEventApi", "Remarks", "Methods", "offactivate()", "onactivate()", "onactivateonce()" ], "headings": [ "Interface: IHyperlinkManagerEventApi", "Remarks", "Methods", "offactivate()", "onactivate()", "onactivateonce()" ], "name": "Interface: IHyperlinkManagerEventApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IHyperlinkManagerEventApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IIframeCardLoader.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IIframeCardLoader.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IIframeCardLoader", "Properties", "autoResolveLoad?", "fileName?", "url?" ], "headings": [ "Interface: IIframeCardLoader", "Properties", "autoResolveLoad?", "fileName?", "url?" ], "name": "Interface: IIframeCardLoader", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IIframeCardLoader" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImageButtonControl.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImageButtonControl.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IImageButtonControl", "Extends", "Properties", "ariaLabel?", "class", "disabled", "id", "isControlCollection", "isFlexible", "isHidden", "onClick()", "order", "permissionCheck?", "role?", "scrollDimensions", "src", "title", "viewModelPath", "Methods", "disable()", "enable()", "hide()", "show()" ], "headings": [ "Interface: IImageButtonControl", "Extends", "Properties", "ariaLabel?", "class", "disabled", "id", "isControlCollection", "isFlexible", "isHidden", "onClick()", "order", "permissionCheck?", "role?", "scrollDimensions", "src", "title", "viewModelPath", "Methods", "disable()", "enable()", "hide()", "show()" ], "name": "Interface: IImageButtonControl", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IImageButtonControl" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImageViewer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImageViewer.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IImageViewer", "Extends", "Properties", "activeMarkupSetArtifactId?", "annotationCount", "annotationToolMode?", "annotationToolSubType?", "annotationToolType?", "cardActivated()?", "cardBuildTabOptions()?", "cardBuildToolbarOptions()?", "cardCanDeactivate()?", "cardCreateUnsupportedOverlayCard()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?", "contextualSearchView", "currentPageIndex", "currentPageName", "designationRendering", "drawingToolType", "enableUnitization", "enableUnitizationRedesign", "hasWaveform", "highlightsEnabled", "id", "loadError", "loadSuccessful", "markupVisibility", "oiPagesLoadedCount", "persistedHighlightColor", "persistedRedactionMode", "persistedRedactionType", "redactionsEnabled", "redactionText", "redactionTextSize", "showWaveformView", "thumbnailView", "timelineView", "totalImageCount", "transcriptDesignationRendering", "transcriptView", "transientHighlight", "type", "unsupportedTabTitle?", "Methods", "cardLoadItem()", "checkHasFeature()", "createAnnotation()", "createCellRange()", "createFullPageRedaction()", "createRectRange()", "createTextRange()", "deleteAllAnnotations()", "deleteAnnotation()", "deleteAnnotations()", "deleteAnnotationType()", "deselectAllAnnotations()", "getAquaView()", "getExternalContent()", "getFeatureManager()", "getHiddenContentStatus()", "getObjectsAtPosition()", "getObjectsAtTranscriptPosition()", "getPageHeight()", "getPageRotation()", "getPageWidth()", "getSelectedAnnotations()", "getSelectionMode()", "hasFeature()", "hasPaging()", "hideRedactions()", "massCreateAnnotation()", "massDeleteAnnotationType()", "moveToNextPage()", "moveToPage()", "moveToPreviousPage()", "openAboutModal()", "openConfirmDeleteImagesModal()", "openCreateMassRedactionModal()", "openDocumentUnitizationModal()", "openEditTextRedactionModal()", "openMassDeleteMarkupModal()", "openSaveAsPdfModal()", "openSingleFileUploadModal()", "persistHighlightColor()", "persistRedactionMode()", "persistRedactionType()", "reloadAnnotations()", "rotateAllPagesClockwise()", "rotateCurrentPageClockwise()", "selectAllAnnotations()", "selectAnnotation()", "selectCellRange()", "selectionRange()", "selectRectRange()", "selectTextRange()", "setActiveMarkupSet()", "setDesignationRendering()", "setDrawingTool()", "setExternalContent()", "setPageLayoutMode()", "setPageRotation()", "setPageRotationAllImages()", "setSelectionMode()", "setTranscriptDesignationRendering()", "showBanner()", "showHiddenContent()", "showRedactions()", "toggleFilterDrawer()", "toggleRedactionOpacity()", "toggleThumbnails()", "totalPageCount()", "transparentRedactions()", "updateAnnotation()", "updateAnnotations()", "zoomIn()", "zoomOut()", "zoomToFit()", "zoomToIndex()" ], "headings": [ "Interface: IImageViewer", "Extends", "Properties", "activeMarkupSetArtifactId?", "annotationCount", "annotationToolMode?", "annotationToolSubType?", "annotationToolType?", "cardActivated()?", "cardBuildTabOptions()?", "cardBuildToolbarOptions()?", "cardCanDeactivate()?", "cardCreateUnsupportedOverlayCard()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?", "contextualSearchView", "currentPageIndex", "currentPageName", "designationRendering", "drawingToolType", "enableUnitization", "enableUnitizationRedesign", "hasWaveform", "highlightsEnabled", "id", "loadError", "loadSuccessful", "markupVisibility", "oiPagesLoadedCount", "persistedHighlightColor", "persistedRedactionMode", "persistedRedactionType", "redactionsEnabled", "redactionText", "redactionTextSize", "showWaveformView", "thumbnailView", "timelineView", "totalImageCount", "transcriptDesignationRendering", "transcriptView", "transientHighlight", "type", "unsupportedTabTitle?", "Methods", "cardLoadItem()", "checkHasFeature()", "createAnnotation()", "createCellRange()", "createFullPageRedaction()", "createRectRange()", "createTextRange()", "deleteAllAnnotations()", "deleteAnnotation()", "deleteAnnotations()", "deleteAnnotationType()", "deselectAllAnnotations()", "getAquaView()", "getExternalContent()", "getFeatureManager()", "getHiddenContentStatus()", "getObjectsAtPosition()", "getObjectsAtTranscriptPosition()", "getPageHeight()", "getPageRotation()", "getPageWidth()", "getSelectedAnnotations()", "getSelectionMode()", "hasFeature()", "hasPaging()", "hideRedactions()", "massCreateAnnotation()", "massDeleteAnnotationType()", "moveToNextPage()", "moveToPage()", "moveToPreviousPage()", "openAboutModal()", "openConfirmDeleteImagesModal()", "openCreateMassRedactionModal()", "openDocumentUnitizationModal()", "openEditTextRedactionModal()", "openMassDeleteMarkupModal()", "openSaveAsPdfModal()", "openSingleFileUploadModal()", "persistHighlightColor()", "persistRedactionMode()", "persistRedactionType()", "reloadAnnotations()", "rotateAllPagesClockwise()", "rotateCurrentPageClockwise()", "selectAllAnnotations()", "selectAnnotation()", "selectCellRange()", "selectionRange()", "selectRectRange()", "selectTextRange()", "setActiveMarkupSet()", "setDesignationRendering()", "setDrawingTool()", "setExternalContent()", "setPageLayoutMode()", "setPageRotation()", "setPageRotationAllImages()", "setSelectionMode()", "setTranscriptDesignationRendering()", "showBanner()", "showHiddenContent()", "showRedactions()", "toggleFilterDrawer()", "toggleRedactionOpacity()", "toggleThumbnails()", "totalPageCount()", "transparentRedactions()", "updateAnnotation()", "updateAnnotations()", "zoomIn()", "zoomOut()", "zoomToFit()", "zoomToIndex()" ], "name": "Interface: IImageViewer", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IImageViewer" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImagingCompletedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImagingCompletedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IImagingCompletedEvent", "Properties", "hasImages" ], "headings": [ "Interface: IImagingCompletedEvent", "Properties", "hasImages" ], "name": "Interface: IImagingCompletedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IImagingCompletedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImagingProfileInfo.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImagingProfileInfo.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IImagingProfileInfo", "Properties", "ArtifactID", "ProfileName", "RestrictedNativeTypes?" ], "headings": [ "Interface: IImagingProfileInfo", "Properties", "ArtifactID", "ProfileName", "RestrictedNativeTypes?" ], "name": "Interface: IImagingProfileInfo", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IImagingProfileInfo" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImagingService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IImagingService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IImagingService", "Extends", "Methods", "canAddImage()", "canCreateImage()", "canDeleteImages()", "canReplaceImage()", "createImage()", "deleteImages()", "getImagingProfilesForUser()", "newImageAdded()", "off()", "on()", "once()" ], "headings": [ "Interface: IImagingService", "Extends", "Methods", "canAddImage()", "canCreateImage()", "canDeleteImages()", "canReplaceImage()", "createImage()", "deleteImages()", "getImagingProfilesForUser()", "newImageAdded()", "off()", "on()", "once()" ], "name": "Interface: IImagingService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IImagingService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IInstanceSettings.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IInstanceSettings.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IInstanceSettings", "Properties", "numberOfDocumentsToPrepareAhead?" ], "headings": [ "Interface: IInstanceSettings", "Properties", "numberOfDocumentsToPrepareAhead?" ], "name": "Interface: IInstanceSettings", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IInstanceSettings" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IInternalApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IInternalApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IInternalApi", "Properties", "queuePointer?", "Methods", "loadQueuePointer()", "prepareQueue()" ], "headings": [ "Interface: IInternalApi", "Properties", "queuePointer?", "Methods", "loadQueuePointer()", "prepareQueue()" ], "name": "Interface: IInternalApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IInternalApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemListFieldValueTransform.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemListFieldValueTransform.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IItemListFieldValueTransform", "Properties", "retrieveFieldArtifactIds", "transformFn" ], "headings": [ "Interface: IItemListFieldValueTransform", "Properties", "retrieveFieldArtifactIds", "transformFn" ], "name": "Interface: IItemListFieldValueTransform", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IItemListFieldValueTransform" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemLoadTransform.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemLoadTransform.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IItemLoadTransform", "Properties", "conflictBehavior", "transformFn", "viewerType" ], "headings": [ "Interface: IItemLoadTransform", "Properties", "conflictBehavior", "transformFn", "viewerType" ], "name": "Interface: IItemLoadTransform", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IItemLoadTransform" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemLoadTransformResult.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemLoadTransformResult.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IItemLoadTransformResult", "Properties", "item", "options" ], "headings": [ "Interface: IItemLoadTransformResult", "Properties", "item", "options" ], "name": "Interface: IItemLoadTransformResult", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IItemLoadTransformResult" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemsAddedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemsAddedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IItemsAddedEvent", "Properties", "index", "items" ], "headings": [ "Interface: IItemsAddedEvent", "Properties", "index", "items" ], "name": "Interface: IItemsAddedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IItemsAddedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemsDeletedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemsDeletedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IItemsDeletedEvent", "Properties", "count", "index" ], "headings": [ "Interface: IItemsDeletedEvent", "Properties", "count", "index" ], "name": "Interface: IItemsDeletedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IItemsDeletedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemsPreloadedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IItemsPreloadedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IItemsPreloadedEvent", "Properties", "currentViewerType", "preloadItems" ], "headings": [ "Interface: IItemsPreloadedEvent", "Properties", "currentViewerType", "preloadItems" ], "name": "Interface: IItemsPreloadedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IItemsPreloadedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcut.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcut.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IKeyboardShortcut", "Properties", "name", "Methods", "clearOverride()", "disable()", "enable()", "rebindShortcuts()", "setOverride()" ], "headings": [ "Interface: IKeyboardShortcut", "Properties", "name", "Methods", "clearOverride()", "disable()", "enable()", "rebindShortcuts()", "setOverride()" ], "name": "Interface: IKeyboardShortcut", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IKeyboardShortcut" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcutAction.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcutAction.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IKeyboardShortcutAction", "Properties", "shortcutFn()" ], "headings": [ "Interface: IKeyboardShortcutAction", "Properties", "shortcutFn()" ], "name": "Interface: IKeyboardShortcutAction", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IKeyboardShortcutAction" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcutData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcutData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IKeyboardShortcutData", "Properties", "artifactId", "fieldData", "hotkey", "name", "type" ], "headings": [ "Interface: IKeyboardShortcutData", "Properties", "artifactId", "fieldData", "hotkey", "name", "type" ], "name": "Interface: IKeyboardShortcutData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IKeyboardShortcutData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcutManager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyboardShortcutManager.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IKeyboardShortcutManager", "Properties", "shortcutsEnabled", "Methods", "addShortcut()", "disableShortcuts()", "enableKeyboardShortcutsOnIframe()", "enableShortcuts()", "getAvailableShortcuts()", "getShortcutByName()" ], "headings": [ "Interface: IKeyboardShortcutManager", "Properties", "shortcutsEnabled", "Methods", "addShortcut()", "disableShortcuts()", "enableKeyboardShortcutsOnIframe()", "enableShortcuts()", "getAvailableShortcuts()", "getShortcutByName()" ], "name": "Interface: IKeyboardShortcutManager", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IKeyboardShortcutManager" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyCombination.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IKeyCombination.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IKeyCombination", "Properties", "alt", "ctrl", "keycode", "shift" ], "headings": [ "Interface: IKeyCombination", "Properties", "alt", "ctrl", "keycode", "shift" ], "name": "Interface: IKeyCombination", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IKeyCombination" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ILoadOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ILoadOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ILoadOptions", "Properties", "cancellationToken?", "forceWebView?", "longTextFieldArtifactId?", "productionArtifactId?", "productionType?", "reconvertRequired?", "reloadRequired?", "transcriptArtifactId?" ], "headings": [ "Interface: ILoadOptions", "Properties", "cancellationToken?", "forceWebView?", "longTextFieldArtifactId?", "productionArtifactId?", "productionType?", "reconvertRequired?", "reloadRequired?", "transcriptArtifactId?" ], "name": "Interface: ILoadOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ILoadOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMarkupSet.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMarkupSet.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IMarkupSet", "Properties", "artifactId", "name", "order", "redactionText" ], "headings": [ "Interface: IMarkupSet", "Properties", "artifactId", "name", "order", "redactionText" ], "name": "Interface: IMarkupSet", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IMarkupSet" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMarkupSetChangedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMarkupSetChangedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IMarkupSetChangedEvent", "Properties", "newMarkupSetArtifactId", "oldMarkupSetArtifactId" ], "headings": [ "Interface: IMarkupSetChangedEvent", "Properties", "newMarkupSetArtifactId", "oldMarkupSetArtifactId" ], "name": "Interface: IMarkupSetChangedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IMarkupSetChangedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMassOperationsService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMassOperationsService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IMassOperationsService", "Methods", "openMassOperationsModal()" ], "headings": [ "Interface: IMassOperationsService", "Methods", "openMassOperationsModal()" ], "name": "Interface: IMassOperationsService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IMassOperationsService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMessageCardBanner.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMessageCardBanner.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IMessageCardBanner", "Extends", "Properties", "bannerClass", "card", "dismissed", "iconClass", "message", "type", "Methods", "dismiss()", "onClick()" ], "headings": [ "Interface: IMessageCardBanner", "Extends", "Properties", "bannerClass", "card", "dismissed", "iconClass", "message", "type", "Methods", "dismiss()", "onClick()" ], "name": "Interface: IMessageCardBanner", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IMessageCardBanner" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMessageCardBannerConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMessageCardBannerConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IMessageCardBannerConfig", "Extends", "Properties", "bannerClass?", "iconClass?", "onclick()?" ], "headings": [ "Interface: IMessageCardBannerConfig", "Extends", "Properties", "bannerClass?", "iconClass?", "onclick()?" ], "name": "Interface: IMessageCardBannerConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IMessageCardBannerConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMetricsApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMetricsApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IMetricsApi", "Properties", "attributes", "Methods", "getMetricAttributes()", "removeAttribute()", "removeMetricAttribute()", "setAttribute()", "setMetricAttribute()" ], "headings": [ "Interface: IMetricsApi", "Properties", "attributes", "Methods", "getMetricAttributes()", "removeAttribute()", "removeMetricAttribute()", "setAttribute()", "setMetricAttribute()" ], "name": "Interface: IMetricsApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IMetricsApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMonitoringConfigration.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IMonitoringConfigration.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IMonitoringConfigration", "Properties", "isDirectNavigation?", "pageBaseTimeOrigin?" ], "headings": [ "Interface: IMonitoringConfigration", "Properties", "isDirectNavigation?", "pageBaseTimeOrigin?" ], "name": "Interface: IMonitoringConfigration", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IMonitoringConfigration" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INameUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INameUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: INameUpdatedEvent", "Properties", "name" ], "headings": [ "Interface: INameUpdatedEvent", "Properties", "name" ], "name": "Interface: INameUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: INameUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INativeService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INativeService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: INativeService", "Extends", "Methods", "canReplaceNative()", "newNativeFileAdded()", "off()", "on()", "once()" ], "headings": [ "Interface: INativeService", "Extends", "Methods", "canReplaceNative()", "newNativeFileAdded()", "off()", "on()", "once()" ], "name": "Interface: INativeService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: INativeService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INoteManagerApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INoteManagerApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: INoteManagerApi", "Remarks", "Methods", "addDesignation()", "byType()", "removeDesignation()" ], "headings": [ "Interface: INoteManagerApi", "Remarks", "Methods", "addDesignation()", "byType()", "removeDesignation()" ], "name": "Interface: INoteManagerApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: INoteManagerApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INoteManagerEventApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INoteManagerEventApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: INoteManagerEventApi", "Remarks", "Methods", "offadd()", "offchange()", "offremove()", "onadd()", "onaddonce()", "onchange()", "onchangeonce()", "onremove()", "onremoveonce()" ], "headings": [ "Interface: INoteManagerEventApi", "Remarks", "Methods", "offadd()", "offchange()", "offremove()", "onadd()", "onaddonce()", "onchange()", "onchangeonce()", "onremove()", "onremoveonce()" ], "name": "Interface: INoteManagerEventApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: INoteManagerEventApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INoteT.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_INoteT.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: INote\u0026lt;T\u0026gt;", "Type Parameters", "Properties", "author?", "date?", "fillColor", "id", "range", "rangeString", "text", "textColor?", "title?", "type", "userData" ], "headings": [ "Interface: INote\u0026lt;T\u0026gt;", "Type Parameters", "Properties", "author?", "date?", "fillColor", "id", "range", "rangeString", "text", "textColor?", "title?", "type", "userData" ], "name": "Interface: INote\u0026lt;T\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: INote\u0026lt;T\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IObjectsEntity.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IObjectsEntity.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IObjectsEntity", "Properties", "ArtifactID", "Values?" ], "headings": [ "Interface: IObjectsEntity", "Properties", "ArtifactID", "Values?" ], "name": "Interface: IObjectsEntity", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IObjectsEntity" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IObjectType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IObjectType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IObjectType", "Properties", "ArtifactID", "ArtifactTypeID", "Guids?", "Name" ], "headings": [ "Interface: IObjectType", "Properties", "ArtifactID", "ArtifactTypeID", "Guids?", "Name" ], "name": "Interface: IObjectType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IObjectType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IOutsideInViewer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IOutsideInViewer.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IOutsideInViewer", "Remarks", "Extends", "Extended by", "Properties", "cardActivated()?", "cardBuildTabOptions()?", "cardBuildToolbarOptions()?", "cardCanDeactivate()?", "cardCreateUnsupportedOverlayCard()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?", "contextualSearchView", "currentPageIndex", "currentPageName", "designationRendering", "hasWaveform", "id", "loadError", "loadSuccessful", "oiPagesLoadedCount", "showWaveformView", "thumbnailView", "timelineView", "transcriptDesignationRendering", "transcriptView", "transientHighlight", "type", "unsupportedTabTitle?", "Methods", "cardLoadItem()", "checkHasFeature()", "createCellRange()", "createRectRange()", "createTextRange()", "getAquaView()", "getExternalContent()", "getFeatureManager()", "getHiddenContentStatus()", "getObjectsAtPosition()", "getObjectsAtTranscriptPosition()", "getPageHeight()", "getPageWidth()", "getSelectionMode()", "hasFeature()", "hasPaging()", "moveToNextPage()", "moveToPage()", "moveToPreviousPage()", "openAboutModal()", "openConfirmDeleteImagesModal()", "openSaveAsPdfModal()", "openSingleFileUploadModal()", "selectCellRange()", "selectionRange()", "selectRectRange()", "selectTextRange()", "setDesignationRendering()", "setExternalContent()", "setPageLayoutMode()", "setSelectionMode()", "setTranscriptDesignationRendering()", "showBanner()", "showHiddenContent()", "toggleFilterDrawer()", "toggleThumbnails()", "totalPageCount()", "zoomIn()", "zoomOut()", "zoomToFit()", "zoomToIndex()" ], "headings": [ "Interface: IOutsideInViewer", "Remarks", "Extends", "Extended by", "Properties", "cardActivated()?", "cardBuildTabOptions()?", "cardBuildToolbarOptions()?", "cardCanDeactivate()?", "cardCreateUnsupportedOverlayCard()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?", "contextualSearchView", "currentPageIndex", "currentPageName", "designationRendering", "hasWaveform", "id", "loadError", "loadSuccessful", "oiPagesLoadedCount", "showWaveformView", "thumbnailView", "timelineView", "transcriptDesignationRendering", "transcriptView", "transientHighlight", "type", "unsupportedTabTitle?", "Methods", "cardLoadItem()", "checkHasFeature()", "createCellRange()", "createRectRange()", "createTextRange()", "getAquaView()", "getExternalContent()", "getFeatureManager()", "getHiddenContentStatus()", "getObjectsAtPosition()", "getObjectsAtTranscriptPosition()", "getPageHeight()", "getPageWidth()", "getSelectionMode()", "hasFeature()", "hasPaging()", "moveToNextPage()", "moveToPage()", "moveToPreviousPage()", "openAboutModal()", "openConfirmDeleteImagesModal()", "openSaveAsPdfModal()", "openSingleFileUploadModal()", "selectCellRange()", "selectionRange()", "selectRectRange()", "selectTextRange()", "setDesignationRendering()", "setExternalContent()", "setPageLayoutMode()", "setSelectionMode()", "setTranscriptDesignationRendering()", "showBanner()", "showHiddenContent()", "toggleFilterDrawer()", "toggleThumbnails()", "totalPageCount()", "zoomIn()", "zoomOut()", "zoomToFit()", "zoomToIndex()" ], "name": "Interface: IOutsideInViewer", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IOutsideInViewer" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPartialMetric.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPartialMetric.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPartialMetric", "Properties", "abandoned", "attributes", "name", "reported", "Methods", "incrementAttribute()", "offPreReport()", "onPreReport()", "removeAttribute()", "setAttribute()" ], "headings": [ "Interface: IPartialMetric", "Properties", "abandoned", "attributes", "name", "reported", "Methods", "incrementAttribute()", "offPreReport()", "onPreReport()", "removeAttribute()", "setAttribute()" ], "name": "Interface: IPartialMetric", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPartialMetric" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPerformanceCheckpoint.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPerformanceCheckpoint.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPerformanceCheckpoint", "Properties", "entry", "name", "workflow" ], "headings": [ "Interface: IPerformanceCheckpoint", "Properties", "entry", "name", "workflow" ], "name": "Interface: IPerformanceCheckpoint", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPerformanceCheckpoint" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPerformanceEntry.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPerformanceEntry.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPerformanceEntry", "Properties", "duration", "entryType", "name", "startTime", "Methods", "toJSON()" ], "headings": [ "Interface: IPerformanceEntry", "Properties", "duration", "entryType", "name", "startTime", "Methods", "toJSON()" ], "name": "Interface: IPerformanceEntry", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPerformanceEntry" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPerformanceWorkflow.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPerformanceWorkflow.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPerformanceWorkflow", "Properties", "context", "id", "name", "startTime", "Methods", "checkpoint()", "checkpointWithEndName()", "complete()", "getCheckpoint()", "getCheckpointTimeFromStart()", "getDuration()", "incrementContext()", "setContext()", "start()" ], "headings": [ "Interface: IPerformanceWorkflow", "Properties", "context", "id", "name", "startTime", "Methods", "checkpoint()", "checkpointWithEndName()", "complete()", "getCheckpoint()", "getCheckpointTimeFromStart()", "getDuration()", "incrementContext()", "setContext()", "start()" ], "name": "Interface: IPerformanceWorkflow", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPerformanceWorkflow" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPermissionCheckRequest.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPermissionCheckRequest.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPermissionCheckRequest", "Properties", "artifactId?", "artifactTypeId", "permissionName" ], "headings": [ "Interface: IPermissionCheckRequest", "Properties", "artifactId?", "artifactTypeId", "permissionName" ], "name": "Interface: IPermissionCheckRequest", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPermissionCheckRequest" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightCountUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightCountUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPersistentHighlightCountUpdatedEvent", "Properties", "isNew", "setCount", "setRendered", "termArtifactId", "termCount", "termRendered" ], "headings": [ "Interface: IPersistentHighlightCountUpdatedEvent", "Properties", "isNew", "setCount", "setRendered", "termArtifactId", "termCount", "termRendered" ], "name": "Interface: IPersistentHighlightCountUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPersistentHighlightCountUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightExpandedUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightExpandedUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPersistentHighlightExpandedUpdatedEvent", "Properties", "expanded", "setArtifactId" ], "headings": [ "Interface: IPersistentHighlightExpandedUpdatedEvent", "Properties", "expanded", "setArtifactId" ], "name": "Interface: IPersistentHighlightExpandedUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPersistentHighlightExpandedUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightSelectedUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightSelectedUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPersistentHighlightSelectedUpdatedEvent", "Properties", "selected", "setArtifactId", "termArtifactId?" ], "headings": [ "Interface: IPersistentHighlightSelectedUpdatedEvent", "Properties", "selected", "setArtifactId", "termArtifactId?" ], "name": "Interface: IPersistentHighlightSelectedUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPersistentHighlightSelectedUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightSet.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightSet.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPersistentHighlightSet", "Properties", "count", "expanded", "hasEditPermission", "id", "order", "persistentHighlightSetArtifactId", "persistentHighlightTerms", "renderedTermCount", "selected", "setName", "syntax", "visible" ], "headings": [ "Interface: IPersistentHighlightSet", "Properties", "count", "expanded", "hasEditPermission", "id", "order", "persistentHighlightSetArtifactId", "persistentHighlightTerms", "renderedTermCount", "selected", "setName", "syntax", "visible" ], "name": "Interface: IPersistentHighlightSet", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPersistentHighlightSet" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightsUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightsUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPersistentHighlightsUpdatedEvent", "Properties", "persistentHighlightData" ], "headings": [ "Interface: IPersistentHighlightsUpdatedEvent", "Properties", "persistentHighlightData" ], "name": "Interface: IPersistentHighlightsUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPersistentHighlightsUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightTerm.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightTerm.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPersistentHighlightTerm", "Properties", "backgroundColor", "count", "foregroundColor", "id", "isElasticSearchTerm?", "isNew?", "isZeroHitStrTerm?", "persistentHighlightSetArtifactId", "persistentHighlightTermArtifactId", "searchData?", "selected", "syntax", "term", "visible" ], "headings": [ "Interface: IPersistentHighlightTerm", "Properties", "backgroundColor", "count", "foregroundColor", "id", "isElasticSearchTerm?", "isNew?", "isZeroHitStrTerm?", "persistentHighlightSetArtifactId", "persistentHighlightTermArtifactId", "searchData?", "selected", "syntax", "term", "visible" ], "name": "Interface: IPersistentHighlightTerm", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPersistentHighlightTerm" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightTermAddedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightTermAddedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPersistentHighlightTermAddedEvent", "Properties", "setId", "syntax", "terms" ], "headings": [ "Interface: IPersistentHighlightTermAddedEvent", "Properties", "setId", "syntax", "terms" ], "name": "Interface: IPersistentHighlightTermAddedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPersistentHighlightTermAddedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightVisibilityUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPersistentHighlightVisibilityUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPersistentHighlightVisibilityUpdatedEvent", "Properties", "setArtifactId", "termArtifactId?", "visible" ], "headings": [ "Interface: IPersistentHighlightVisibilityUpdatedEvent", "Properties", "setArtifactId", "termArtifactId?", "visible" ], "name": "Interface: IPersistentHighlightVisibilityUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPersistentHighlightVisibilityUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPointerCreatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPointerCreatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPointerCreatedEvent", "Properties", "pointer" ], "headings": [ "Interface: IPointerCreatedEvent", "Properties", "pointer" ], "name": "Interface: IPointerCreatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPointerCreatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPopupControlApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPopupControlApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPopupControlApi", "Properties", "closePopup()", "isPopupSafeAndLive()", "popup" ], "headings": [ "Interface: IPopupControlApi", "Properties", "closePopup()", "isPopupSafeAndLive()", "popup" ], "name": "Interface: IPopupControlApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPopupControlApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPopupEventNames.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPopupEventNames.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPopupEventNames", "Properties", "CREATE_ACTION_BAR", "CREATE_CONSOLE", "EVENT_HANDLERS_REGISTERED", "HYDRATE_LAYOUT", "HYDRATE_LAYOUT_COMPLETE", "ITEM_LIST_MODIFY_ACTIONS", "ITEM_LIST_MODIFY_COLUMNS", "ITEM_LIST_RELOADED", "OVERRIDE_PICKER_DATASOURCE", "PAGE_INTERACTION", "PAGE_LOAD_COMPLETE", "PAGE_UNLOAD", "POST_DELETE", "POST_OBTAIN_ADDITIONAL_DATA", "POST_SAVE", "PRE_DELETE", "PRE_SAVE", "REPLACE_DELETE", "REPLACE_FILE_ACTIONS", "REPLACE_GET_NEW_OBJECT_INSTANCE", "REPLACE_OBTAIN_ADDITIONAL_DATA", "REPLACE_READ", "REPLACE_READ_DELETE_DEPENDENCY_LIST", "REPLACE_SAVE", "TRANSFORM_LAYOUT", "UPDATE_ACTION_BAR", "UPDATE_CONSOLE", "VALIDATE_SAVE", "VALIDATION" ], "headings": [ "Interface: IPopupEventNames", "Properties", "CREATE_ACTION_BAR", "CREATE_CONSOLE", "EVENT_HANDLERS_REGISTERED", "HYDRATE_LAYOUT", "HYDRATE_LAYOUT_COMPLETE", "ITEM_LIST_MODIFY_ACTIONS", "ITEM_LIST_MODIFY_COLUMNS", "ITEM_LIST_RELOADED", "OVERRIDE_PICKER_DATASOURCE", "PAGE_INTERACTION", "PAGE_LOAD_COMPLETE", "PAGE_UNLOAD", "POST_DELETE", "POST_OBTAIN_ADDITIONAL_DATA", "POST_SAVE", "PRE_DELETE", "PRE_SAVE", "REPLACE_DELETE", "REPLACE_FILE_ACTIONS", "REPLACE_GET_NEW_OBJECT_INSTANCE", "REPLACE_OBTAIN_ADDITIONAL_DATA", "REPLACE_READ", "REPLACE_READ_DELETE_DEPENDENCY_LIST", "REPLACE_SAVE", "TRANSFORM_LAYOUT", "UPDATE_ACTION_BAR", "UPDATE_CONSOLE", "VALIDATE_SAVE", "VALIDATION" ], "name": "Interface: IPopupEventNames", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPopupEventNames" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPreloadItem.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPreloadItem.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPreloadItem", "Properties", "queueItems", "viewerType" ], "headings": [ "Interface: IPreloadItem", "Properties", "queueItems", "viewerType" ], "name": "Interface: IPreloadItem", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPreloadItem" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPreloadService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPreloadService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPreloadService", "Extends", "Methods", "abort()", "off()", "on()", "once()", "prepareDocuments()", "prepareQueue()", "prepareViewerQueue()" ], "headings": [ "Interface: IPreloadService", "Extends", "Methods", "abort()", "off()", "on()", "once()", "prepareDocuments()", "prepareQueue()", "prepareViewerQueue()" ], "name": "Interface: IPreloadService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPreloadService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPrepareQueueOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPrepareQueueOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPrepareQueueOptions", "Properties", "cancellationToken?", "prepareTarget?", "viewerCollection?" ], "headings": [ "Interface: IPrepareQueueOptions", "Properties", "cancellationToken?", "prepareTarget?", "viewerCollection?" ], "name": "Interface: IPrepareQueueOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPrepareQueueOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPreviewApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPreviewApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPreviewApi", "Extends", "Methods", "off()", "on()", "once()", "popin()", "popout()", "setDocument()", "setQueue()" ], "headings": [ "Interface: IPreviewApi", "Extends", "Methods", "off()", "on()", "once()", "popin()", "popout()", "setDocument()", "setQueue()" ], "name": "Interface: IPreviewApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPreviewApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IProductionHistoryItem.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IProductionHistoryItem.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IProductionHistoryItem", "Properties", "ArtifactID", "BeginAttachment", "BeginBates", "DateProduced", "EndAttachment", "EndBates", "Name", "WorkspaceID" ], "headings": [ "Interface: IProductionHistoryItem", "Properties", "ArtifactID", "BeginAttachment", "BeginBates", "DateProduced", "EndAttachment", "EndBates", "Name", "WorkspaceID" ], "name": "Interface: IProductionHistoryItem", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IProductionHistoryItem" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IProductionHistoryService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IProductionHistoryService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IProductionHistoryService", "Methods", "getProductionHistory()" ], "headings": [ "Interface: IProductionHistoryService", "Methods", "getProductionHistory()" ], "name": "Interface: IProductionHistoryService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IProductionHistoryService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IProductionViewer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IProductionViewer.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IProductionViewer", "Extends", "Properties", "cardActivated()?", "cardBuildTabOptions()?", "cardBuildToolbarOptions()?", "cardCanDeactivate()?", "cardCreateUnsupportedOverlayCard()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?", "contextualSearchView", "currentPageIndex", "currentPageName", "designationRendering", "hasWaveform", "highlights", "id", "loadError", "loadSuccessful", "oiPagesLoadedCount", "shouldHighlight", "showWaveformView", "thumbnailView", "timelineView", "transcriptDesignationRendering", "transcriptView", "transientHighlight", "type", "unsupportedTabTitle?", "Methods", "cardLoadItem()", "checkHasFeature()", "createCellRange()", "createRectRange()", "createTextRange()", "getAquaView()", "getExternalContent()", "getFeatureManager()", "getHiddenContentStatus()", "getObjectsAtPosition()", "getObjectsAtTranscriptPosition()", "getPageHeight()", "getPageRotation()", "getPageWidth()", "getSelectionMode()", "hasFeature()", "hasPaging()", "moveToNextPage()", "moveToPage()", "moveToPreviousPage()", "off()", "on()", "once()", "openAboutModal()", "openConfirmDeleteImagesModal()", "openSaveAsPdfModal()", "openSingleFileUploadModal()", "rotateAllPagesClockwise()", "rotateCurrentPageClockwise()", "selectCellRange()", "selectionRange()", "selectRectRange()", "selectTextRange()", "setDesignationRendering()", "setExternalContent()", "setPageLayoutMode()", "setPageRotation()", "setPageRotationAllImages()", "setSelectionMode()", "setTranscriptDesignationRendering()", "showBanner()", "showHiddenContent()", "toggleFilterDrawer()", "toggleThumbnails()", "totalPageCount()", "zoomIn()", "zoomOut()", "zoomToFit()", "zoomToIndex()" ], "headings": [ "Interface: IProductionViewer", "Extends", "Properties", "cardActivated()?", "cardBuildTabOptions()?", "cardBuildToolbarOptions()?", "cardCanDeactivate()?", "cardCreateUnsupportedOverlayCard()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?", "contextualSearchView", "currentPageIndex", "currentPageName", "designationRendering", "hasWaveform", "highlights", "id", "loadError", "loadSuccessful", "oiPagesLoadedCount", "shouldHighlight", "showWaveformView", "thumbnailView", "timelineView", "transcriptDesignationRendering", "transcriptView", "transientHighlight", "type", "unsupportedTabTitle?", "Methods", "cardLoadItem()", "checkHasFeature()", "createCellRange()", "createRectRange()", "createTextRange()", "getAquaView()", "getExternalContent()", "getFeatureManager()", "getHiddenContentStatus()", "getObjectsAtPosition()", "getObjectsAtTranscriptPosition()", "getPageHeight()", "getPageRotation()", "getPageWidth()", "getSelectionMode()", "hasFeature()", "hasPaging()", "moveToNextPage()", "moveToPage()", "moveToPreviousPage()", "off()", "on()", "once()", "openAboutModal()", "openConfirmDeleteImagesModal()", "openSaveAsPdfModal()", "openSingleFileUploadModal()", "rotateAllPagesClockwise()", "rotateCurrentPageClockwise()", "selectCellRange()", "selectionRange()", "selectRectRange()", "selectTextRange()", "setDesignationRendering()", "setExternalContent()", "setPageLayoutMode()", "setPageRotation()", "setPageRotationAllImages()", "setSelectionMode()", "setTranscriptDesignationRendering()", "showBanner()", "showHiddenContent()", "toggleFilterDrawer()", "toggleThumbnails()", "totalPageCount()", "zoomIn()", "zoomOut()", "zoomToFit()", "zoomToIndex()" ], "name": "Interface: IProductionViewer", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IProductionViewer" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPublicDocumentData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPublicDocumentData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPublicDocumentData", "Properties", "fileExtension", "hasNativeFileDownloadPermission", "nativeData?", "preventNativeDownload", "redactFileInfo", "redactProductionLock" ], "headings": [ "Interface: IPublicDocumentData", "Properties", "fileExtension", "hasNativeFileDownloadPermission", "nativeData?", "preventNativeDownload", "redactFileInfo", "redactProductionLock" ], "name": "Interface: IPublicDocumentData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPublicDocumentData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPublicDocumentNativeData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IPublicDocumentNativeData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IPublicDocumentNativeData", "Properties", "fileTypeId", "relativityNativeType" ], "headings": [ "Interface: IPublicDocumentNativeData", "Properties", "fileTypeId", "relativityNativeType" ], "name": "Interface: IPublicDocumentNativeData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IPublicDocumentNativeData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueue.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueue.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IQueue", "Extends", "Properties", "customData", "id", "length", "name", "pointers", "Methods", "addItemAtEnd()", "addItemAtIndex()", "addItemsAtEnd()", "addItemsAtIndex()", "createPointer()", "deleteItemAtIndex()", "deleteItemsAtIndex()", "getDocumentIds()", "getDocumentItemIndex()", "getItem()", "getItems()", "getQueueItemIdentifiers()", "getQueueItemIndex()", "itemsEquivalent()", "moveItemsToIndex()", "moveItemToIndex()", "off()", "on()", "once()", "setCustomData()" ], "headings": [ "Interface: IQueue", "Extends", "Properties", "customData", "id", "length", "name", "pointers", "Methods", "addItemAtEnd()", "addItemAtIndex()", "addItemsAtEnd()", "addItemsAtIndex()", "createPointer()", "deleteItemAtIndex()", "deleteItemsAtIndex()", "getDocumentIds()", "getDocumentItemIndex()", "getItem()", "getItems()", "getQueueItemIdentifiers()", "getQueueItemIndex()", "itemsEquivalent()", "moveItemsToIndex()", "moveItemToIndex()", "off()", "on()", "once()", "setCustomData()" ], "name": "Interface: IQueue", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IQueue" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueCreatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueCreatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IQueueCreatedEvent", "Properties", "queue" ], "headings": [ "Interface: IQueueCreatedEvent", "Properties", "queue" ], "name": "Interface: IQueueCreatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IQueueCreatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueDeletedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueDeletedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IQueueDeletedEvent", "Properties", "queue" ], "headings": [ "Interface: IQueueDeletedEvent", "Properties", "queue" ], "name": "Interface: IQueueDeletedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IQueueDeletedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueItem.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueItem.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IQueueItem", "Extended by", "Properties", "extension", "id", "itemIdentifier", "itemTransforms?", "label", "type" ], "headings": [ "Interface: IQueueItem", "Extended by", "Properties", "extension", "id", "itemIdentifier", "itemTransforms?", "label", "type" ], "name": "Interface: IQueueItem", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IQueueItem" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueItemIdentifier.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueItemIdentifier.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IQueueItemIdentifier", "Extended by", "Properties", "id?" ], "headings": [ "Interface: IQueueItemIdentifier", "Extended by", "Properties", "id?" ], "name": "Interface: IQueueItemIdentifier", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IQueueItemIdentifier" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueuePointer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueuePointer.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IQueuePointer", "Extends", "Properties", "activationStatus", "id", "index", "item", "longTextArtifactId", "productionArtifactId", "productionType", "queue", "type", "Methods", "activate()", "copy()", "navigate()", "navigateBy()", "navigateToFirst()", "navigateToIndex()", "navigateToLast()", "navigateToNext()", "navigateToPrevious()", "off()", "on()", "once()", "requestUpdate()", "switchViewer()" ], "headings": [ "Interface: IQueuePointer", "Extends", "Properties", "activationStatus", "id", "index", "item", "longTextArtifactId", "productionArtifactId", "productionType", "queue", "type", "Methods", "activate()", "copy()", "navigate()", "navigateBy()", "navigateToFirst()", "navigateToIndex()", "navigateToLast()", "navigateToNext()", "navigateToPrevious()", "off()", "on()", "once()", "requestUpdate()", "switchViewer()" ], "name": "Interface: IQueuePointer", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IQueuePointer" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueuePointerChangedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueuePointerChangedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IQueuePointerChangedEvent", "Properties", "newPointer", "oldPointer" ], "headings": [ "Interface: IQueuePointerChangedEvent", "Properties", "newPointer", "oldPointer" ], "name": "Interface: IQueuePointerChangedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IQueuePointerChangedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IQueueService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IQueueService", "Extends", "Properties", "queues", "Methods", "createDocumentItem()", "createQueue()", "createRdoFileItem()", "deleteQueue()", "getQueueById()", "off()", "on()", "once()" ], "headings": [ "Interface: IQueueService", "Extends", "Properties", "queues", "Methods", "createDocumentItem()", "createQueue()", "createRdoFileItem()", "deleteQueue()", "getQueueById()", "off()", "on()", "once()" ], "name": "Interface: IQueueService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IQueueService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRangeMementoHelper.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRangeMementoHelper.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRangeMementoHelper", "Methods", "createLineRangeMementos()", "createTextRangeMemento()" ], "headings": [ "Interface: IRangeMementoHelper", "Methods", "createLineRangeMementos()", "createTextRangeMemento()" ], "name": "Interface: IRangeMementoHelper", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRangeMementoHelper" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRDOFileItem.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRDOFileItem.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRDOFileItem", "Extends", "Properties", "extension", "fileFieldArtifactId", "fileId", "id", "itemIdentifier", "itemTransforms?", "label", "type" ], "headings": [ "Interface: IRDOFileItem", "Extends", "Properties", "extension", "fileFieldArtifactId", "fileId", "id", "itemIdentifier", "itemTransforms?", "label", "type" ], "name": "Interface: IRDOFileItem", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRDOFileItem" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRDOFileItemIdentifier.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRDOFileItemIdentifier.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRDOFileItemIdentifier", "Extends", "Properties", "fileFieldArtifactId", "fileId", "id?" ], "headings": [ "Interface: IRDOFileItemIdentifier", "Extends", "Properties", "fileFieldArtifactId", "fileId", "id?" ], "name": "Interface: IRDOFileItemIdentifier", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRDOFileItemIdentifier" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchSetExpandedStateUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchSetExpandedStateUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRecentSearchSetExpandedStateUpdatedEvent", "Properties", "expanded" ], "headings": [ "Interface: IRecentSearchSetExpandedStateUpdatedEvent", "Properties", "expanded" ], "name": "Interface: IRecentSearchSetExpandedStateUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRecentSearchSetExpandedStateUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchSetUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchSetUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRecentSearchSetUpdatedEvent", "Properties", "recentSearchSetData" ], "headings": [ "Interface: IRecentSearchSetUpdatedEvent", "Properties", "recentSearchSetData" ], "name": "Interface: IRecentSearchSetUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRecentSearchSetUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchSetVisibilityUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchSetVisibilityUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRecentSearchSetVisibilityUpdatedEvent", "Properties", "visible" ], "headings": [ "Interface: IRecentSearchSetVisibilityUpdatedEvent", "Properties", "visible" ], "name": "Interface: IRecentSearchSetVisibilityUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRecentSearchSetVisibilityUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermAddedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermAddedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRecentSearchTermAddedEvent", "Properties", "activeViewerType", "termArtifactId" ], "headings": [ "Interface: IRecentSearchTermAddedEvent", "Properties", "activeViewerType", "termArtifactId" ], "name": "Interface: IRecentSearchTermAddedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRecentSearchTermAddedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermClearedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermClearedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRecentSearchTermClearedEvent", "Properties", "termArtifactIds" ], "headings": [ "Interface: IRecentSearchTermClearedEvent", "Properties", "termArtifactIds" ], "name": "Interface: IRecentSearchTermClearedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRecentSearchTermClearedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermCountUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermCountUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRecentSearchTermCountUpdatedEvent", "Properties", "setCount", "setRendered", "termArtifactId", "termCount", "termRendered", "viewerType" ], "headings": [ "Interface: IRecentSearchTermCountUpdatedEvent", "Properties", "setCount", "setRendered", "termArtifactId", "termCount", "termRendered", "viewerType" ], "name": "Interface: IRecentSearchTermCountUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRecentSearchTermCountUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermVisibilityUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRecentSearchTermVisibilityUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRecentSearchTermVisibilityUpdatedEvent", "Properties", "termArtifactId", "visible" ], "headings": [ "Interface: IRecentSearchTermVisibilityUpdatedEvent", "Properties", "termArtifactId", "visible" ], "name": "Interface: IRecentSearchTermVisibilityUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRecentSearchTermVisibilityUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRedactFileInfo.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRedactFileInfo.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRedactFileInfo", "Properties", "documentArtifactId", "redactFileFieldArtifactId", "redactFileId", "redactFileLastUpdated", "redactMarkupSetId" ], "headings": [ "Interface: IRedactFileInfo", "Properties", "documentArtifactId", "redactFileFieldArtifactId", "redactFileId", "redactFileLastUpdated", "redactMarkupSetId" ], "name": "Interface: IRedactFileInfo", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRedactFileInfo" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelatedItemsService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelatedItemsService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelatedItemsService", "Properties", "currentPane", "paneColumns", "paneData", "panes" ], "headings": [ "Interface: IRelatedItemsService", "Properties", "currentPane", "paneColumns", "paneData", "panes" ], "name": "Interface: IRelatedItemsService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelatedItemsService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelationalField.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelationalField.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelationalField", "Properties", "ArtifactID", "FieldCategory", "FieldType", "Guids?", "ViewFieldID" ], "headings": [ "Interface: IRelationalField", "Properties", "ArtifactID", "FieldCategory", "FieldType", "Guids?", "ViewFieldID" ], "name": "Interface: IRelationalField", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelationalField" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityConfiguration.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityConfiguration.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityConfiguration", "Properties", "authMode?", "baseUrl?", "bearerToken?", "enableRelativityInternalRouting?", "environmentType", "initialIndex", "initialLongTextArtifactId?", "initialPageLayout?", "initialProductionArtifactId?", "initialProductionType?", "initialReviewQueueDocuments?", "initialReviewQueueItemIdentifiers?", "initialThumbnailVisibility", "initialType", "initialZoomLevel", "initialZoomMode", "region", "servicesBaseUrl?", "tenantId", "workspaceId" ], "headings": [ "Interface: IRelativityConfiguration", "Properties", "authMode?", "baseUrl?", "bearerToken?", "enableRelativityInternalRouting?", "environmentType", "initialIndex", "initialLongTextArtifactId?", "initialPageLayout?", "initialProductionArtifactId?", "initialProductionType?", "initialReviewQueueDocuments?", "initialReviewQueueItemIdentifiers?", "initialThumbnailVisibility", "initialType", "initialZoomLevel", "initialZoomMode", "region", "servicesBaseUrl?", "tenantId", "workspaceId" ], "name": "Interface: IRelativityConfiguration", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityConfiguration" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsActionBarAPI.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsActionBarAPI.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsActionBarAPI", "Properties", "defaultActions" ], "headings": [ "Interface: IRelativityFormsActionBarAPI", "Properties", "defaultActions" ], "name": "Interface: IRelativityFormsActionBarAPI", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsActionBarAPI" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsConvenienceAPI.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsConvenienceAPI.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsConvenienceAPI", "Properties", "actionBar", "fieldHelper", "layout", "navigation", "relativityFormsPopup", "Methods", "getCurrentFormState()" ], "headings": [ "Interface: IRelativityFormsConvenienceAPI", "Properties", "actionBar", "fieldHelper", "layout", "navigation", "relativityFormsPopup", "Methods", "getCurrentFormState()" ], "name": "Interface: IRelativityFormsConvenienceAPI", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsConvenienceAPI" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsDefaultActionsAPI.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsDefaultActionsAPI.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsDefaultActionsAPI", "Methods", "save()", "saveAndContinue()", "saveAndGo()" ], "headings": [ "Interface: IRelativityFormsDefaultActionsAPI", "Methods", "save()", "saveAndContinue()", "saveAndGo()" ], "name": "Interface: IRelativityFormsDefaultActionsAPI", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsDefaultActionsAPI" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelope.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelope.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsEnvelope", "Properties", "dispatchEvent()?", "getPreloadObjectIds()?", "modal?", "navigate()?", "setConvenienceApi()?", "settings?" ], "headings": [ "Interface: IRelativityFormsEnvelope", "Properties", "dispatchEvent()?", "getPreloadObjectIds()?", "modal?", "navigate()?", "setConvenienceApi()?", "settings?" ], "name": "Interface: IRelativityFormsEnvelope", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsEnvelope" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeActionBarSettings.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeActionBarSettings.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsEnvelopeActionBarSettings", "Properties", "customButtons?", "hideBack?", "hideCancel?", "hideDelete?", "hideEdit?", "hideEditPermissions?", "hidePager?", "hideSave?", "hideSaveAndBack?", "hideSaveAndNew?", "hideSaveAndNext?", "hideSaveAndPrevious?", "hideViewAudit?", "layoutControlsSlotPosition?" ], "headings": [ "Interface: IRelativityFormsEnvelopeActionBarSettings", "Properties", "customButtons?", "hideBack?", "hideCancel?", "hideDelete?", "hideEdit?", "hideEditPermissions?", "hidePager?", "hideSave?", "hideSaveAndBack?", "hideSaveAndNew?", "hideSaveAndNext?", "hideSaveAndPrevious?", "hideViewAudit?", "layoutControlsSlotPosition?" ], "name": "Interface: IRelativityFormsEnvelopeActionBarSettings", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsEnvelopeActionBarSettings" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeCustomButtonSettings.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeCustomButtonSettings.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsEnvelopeCustomButtonSettings", "Properties", "actionType", "className", "id", "isDisabled", "name", "onBuild()?", "onClick()", "order", "slotPosition", "visibleMode" ], "headings": [ "Interface: IRelativityFormsEnvelopeCustomButtonSettings", "Properties", "actionType", "className", "id", "isDisabled", "name", "onBuild()?", "onClick()", "order", "slotPosition", "visibleMode" ], "name": "Interface: IRelativityFormsEnvelopeCustomButtonSettings", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsEnvelopeCustomButtonSettings" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeModal.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeModal.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsEnvelopeModal", "Properties", "close()", "open()" ], "headings": [ "Interface: IRelativityFormsEnvelopeModal", "Properties", "close()", "open()" ], "name": "Interface: IRelativityFormsEnvelopeModal", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsEnvelopeModal" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeSettings.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsEnvelopeSettings.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsEnvelopeSettings", "Properties", "actionBar?", "appGuids?", "canControlRelativityWindow?", "enableChildAndAssociativeListsInEditMode?", "enableCompactMode?", "enableCopyFromPrevious?", "enablePropagation?" ], "headings": [ "Interface: IRelativityFormsEnvelopeSettings", "Properties", "actionBar?", "appGuids?", "canControlRelativityWindow?", "enableChildAndAssociativeListsInEditMode?", "enableCompactMode?", "enableCopyFromPrevious?", "enablePropagation?" ], "name": "Interface: IRelativityFormsEnvelopeSettings", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsEnvelopeSettings" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsFieldHelper.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsFieldHelper.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsFieldHelper", "Methods", "getHtmlElement()", "getValue()", "setCopyFromPreviousState()", "setValue()" ], "headings": [ "Interface: IRelativityFormsFieldHelper", "Methods", "getHtmlElement()", "getValue()", "setCopyFromPreviousState()", "setValue()" ], "name": "Interface: IRelativityFormsFieldHelper", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsFieldHelper" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayout.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayout.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsLayout", "Properties", "AllowCopyFromPrevious", "ArtifactTypeId", "Groups", "Guids", "IsLocked", "LayoutID", "Name", "OverwriteProtection" ], "headings": [ "Interface: IRelativityFormsLayout", "Properties", "AllowCopyFromPrevious", "ArtifactTypeId", "Groups", "Guids", "IsLocked", "LayoutID", "Name", "OverwriteProtection" ], "name": "Interface: IRelativityFormsLayout", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsLayout" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutFieldElement.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutFieldElement.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsLayoutFieldElement", "Properties", "AllowCopyFromPrevious", "AllowHTML", "ColSpan", "Column", "copyFromPreviousState", "DisplayName", "DisplayType?", "expanded", "FieldCategoryID", "FieldID", "FieldType", "Guids", "IsReadOnly", "IsRequired", "IsSystem", "MaxLength?", "minimumWidth", "NameValue", "RepeatColumn?", "Row", "ShowNameColumn" ], "headings": [ "Interface: IRelativityFormsLayoutFieldElement", "Properties", "AllowCopyFromPrevious", "AllowHTML", "ColSpan", "Column", "copyFromPreviousState", "DisplayName", "DisplayType?", "expanded", "FieldCategoryID", "FieldID", "FieldType", "Guids", "IsReadOnly", "IsRequired", "IsSystem", "MaxLength?", "minimumWidth", "NameValue", "RepeatColumn?", "Row", "ShowNameColumn" ], "name": "Interface: IRelativityFormsLayoutFieldElement", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsLayoutFieldElement" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutGroup.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutGroup.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsLayoutGroup", "Properties", "Elements", "GroupID", "Order", "TabbedDisplay" ], "headings": [ "Interface: IRelativityFormsLayoutGroup", "Properties", "Elements", "GroupID", "Order", "TabbedDisplay" ], "name": "Interface: IRelativityFormsLayoutGroup", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsLayoutGroup" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutGroupElement.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutGroupElement.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsLayoutGroupElement", "Properties", "CategoryID", "Collapsible", "DefaultCollapsed", "Elements", "Order", "Titles" ], "headings": [ "Interface: IRelativityFormsLayoutGroupElement", "Properties", "CategoryID", "Collapsible", "DefaultCollapsed", "Elements", "Order", "Titles" ], "name": "Interface: IRelativityFormsLayoutGroupElement", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsLayoutGroupElement" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutHelper.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsLayoutHelper.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsLayoutHelper", "Methods", "getFields()" ], "headings": [ "Interface: IRelativityFormsLayoutHelper", "Methods", "getFields()" ], "name": "Interface: IRelativityFormsLayoutHelper", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsLayoutHelper" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsNavigateToFormNavigationOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsNavigateToFormNavigationOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsNavigateToFormNavigationOptions", "Properties", "shouldFirePageUnloadEventHandlers?", "showLoader?", "skipVolatileDataWarning?" ], "headings": [ "Interface: IRelativityFormsNavigateToFormNavigationOptions", "Properties", "shouldFirePageUnloadEventHandlers?", "showLoader?", "skipVolatileDataWarning?" ], "name": "Interface: IRelativityFormsNavigateToFormNavigationOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsNavigateToFormNavigationOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsNavigateToFormParameters.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsNavigateToFormParameters.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsNavigateToFormParameters", "Properties", "artifactId", "artifactTypeId", "workspaceId" ], "headings": [ "Interface: IRelativityFormsNavigateToFormParameters", "Properties", "artifactId", "artifactTypeId", "workspaceId" ], "name": "Interface: IRelativityFormsNavigateToFormParameters", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsNavigateToFormParameters" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsNavigationAPI.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsNavigationAPI.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsNavigationAPI", "Methods", "navigateToArtifactId()", "navigateToForm()" ], "headings": [ "Interface: IRelativityFormsNavigationAPI", "Methods", "navigateToArtifactId()", "navigateToForm()" ], "name": "Interface: IRelativityFormsNavigationAPI", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsNavigationAPI" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsPopupFactory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsPopupFactory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsPopupFactory", "Properties", "openAdd()", "openEdit()", "openView()" ], "headings": [ "Interface: IRelativityFormsPopupFactory", "Properties", "openAdd()", "openEdit()", "openView()" ], "name": "Interface: IRelativityFormsPopupFactory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsPopupFactory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsSaveOperation.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsSaveOperation.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsSaveOperation", "Properties", "artifactId?", "saveOperation?" ], "headings": [ "Interface: IRelativityFormsSaveOperation", "Properties", "artifactId?", "saveOperation?" ], "name": "Interface: IRelativityFormsSaveOperation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsSaveOperation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsState.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityFormsState.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityFormsState", "Properties", "artifactId", "artifactTypeId", "backingModelData", "currentSaveOperation", "fieldNameToFieldIdMap", "isDirty", "isSaveInProgress", "layoutId", "layoutMetadataCopy", "parentArtifactId", "viewModelName", "volatileModelData", "workspaceId" ], "headings": [ "Interface: IRelativityFormsState", "Properties", "artifactId", "artifactTypeId", "backingModelData", "currentSaveOperation", "fieldNameToFieldIdMap", "isDirty", "isSaveInProgress", "layoutId", "layoutMetadataCopy", "parentArtifactId", "viewModelName", "volatileModelData", "workspaceId" ], "name": "Interface: IRelativityFormsState", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityFormsState" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityTenantContext.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRelativityTenantContext.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRelativityTenantContext", "Properties", "environmentType", "instanceGuid", "podId", "regionId", "ringId", "ringOrder", "tenantId" ], "headings": [ "Interface: IRelativityTenantContext", "Properties", "environmentType", "instanceGuid", "podId", "regionId", "ringId", "ringOrder", "tenantId" ], "name": "Interface: IRelativityTenantContext", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRelativityTenantContext" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReloadCompletedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReloadCompletedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IReloadCompletedEvent", "Properties", "reloadError?", "reloadSuccessful" ], "headings": [ "Interface: IReloadCompletedEvent", "Properties", "reloadError?", "reloadSuccessful" ], "name": "Interface: IReloadCompletedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IReloadCompletedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReloadOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReloadOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IReloadOptions", "Properties", "reconvert?" ], "headings": [ "Interface: IReloadOptions", "Properties", "reconvert?" ], "name": "Interface: IReloadOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IReloadOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRenderContentHighlightsParametersVType__CType__CTType__CKType__CVType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRenderContentHighlightsParametersVType__CType__CTType__CKType__CVType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRenderContentHighlightsParameters\u0026lt;VType, CType, CTType, CKType, CVType\u0026gt;", "Type Parameters", "Properties", "abortSignal", "api", "cache", "content", "documentMetric", "forceRefresh", "highlightingApi?", "viewer", "viewerCollection", "workflow" ], "headings": [ "Interface: IRenderContentHighlightsParameters\u0026lt;VType, CType, CTType, CKType, CVType\u0026gt;", "Type Parameters", "Properties", "abortSignal", "api", "cache", "content", "documentMetric", "forceRefresh", "highlightingApi?", "viewer", "viewerCollection", "workflow" ], "name": "Interface: IRenderContentHighlightsParameters\u0026lt;VType, CType, CTType, CKType, CVType\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRenderContentHighlightsParameters\u0026lt;VType, CType, CTType, CKType, CVType\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReportOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReportOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IReportOptions", "Properties", "reportTimeout?", "ReportToAPM?", "ReportToConsole?" ], "headings": [ "Interface: IReportOptions", "Properties", "reportTimeout?", "ReportToAPM?", "ReportToConsole?" ], "name": "Interface: IReportOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IReportOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRequestMessage.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRequestMessage.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRequestMessage", "Properties", "baseUrl", "content", "headers", "method", "traditional", "url", "Methods", "buildFullUrl()" ], "headings": [ "Interface: IRequestMessage", "Properties", "baseUrl", "content", "headers", "method", "traditional", "url", "Methods", "buildFullUrl()" ], "name": "Interface: IRequestMessage", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRequestMessage" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReviewInterfaceApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IReviewInterfaceApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IReviewInterfaceApi", "Properties", "annotations", "cards", "configuration", "contextMenu", "convenienceApi", "documentActions", "documentDataCacheManager", "documentList", "embeddedContextKey?", "extensions", "fileService", "highlights", "imaging", "keyboardShortcuts", "lifecycle", "preload", "toolbar", "utilities", "version", "viewer", "viewerContentKeyCacheManager", "viewerSettings", "window", "Methods", "off()", "on()" ], "headings": [ "Interface: IReviewInterfaceApi", "Properties", "annotations", "cards", "configuration", "contextMenu", "convenienceApi", "documentActions", "documentDataCacheManager", "documentList", "embeddedContextKey?", "extensions", "fileService", "highlights", "imaging", "keyboardShortcuts", "lifecycle", "preload", "toolbar", "utilities", "version", "viewer", "viewerContentKeyCacheManager", "viewerSettings", "window", "Methods", "off()", "on()" ], "name": "Interface: IReviewInterfaceApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IReviewInterfaceApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRotatableViewer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRotatableViewer.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRotatableViewer", "Extended by", "Methods", "getPageRotation()", "rotateAllPagesClockwise()", "rotateCurrentPageClockwise()", "setPageRotation()", "setPageRotationAllImages()" ], "headings": [ "Interface: IRotatableViewer", "Extended by", "Methods", "getPageRotation()", "rotateAllPagesClockwise()", "rotateCurrentPageClockwise()", "setPageRotation()", "setPageRotationAllImages()" ], "name": "Interface: IRotatableViewer", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRotatableViewer" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRotationApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRotationApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRotationApi", "Methods", "rotateAllPagesClockwise()", "rotateCurrentPageClockwise()", "setPageRotation()", "setPageRotationAllImages()" ], "headings": [ "Interface: IRotationApi", "Methods", "rotateAllPagesClockwise()", "rotateCurrentPageClockwise()", "setPageRotation()", "setPageRotationAllImages()" ], "name": "Interface: IRotationApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRotationApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRTCMessageHandler.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRTCMessageHandler.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRTCMessageHandler", "Properties", "handler", "messageHandler?", "messageName?", "name" ], "headings": [ "Interface: IRTCMessageHandler", "Properties", "handler", "messageHandler?", "messageName?", "name" ], "name": "Interface: IRTCMessageHandler", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRTCMessageHandler" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRwcHtmlElement.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IRwcHtmlElement.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IRwcHtmlElement", "Properties", "disabled", "editMode", "Methods", "focus()" ], "headings": [ "Interface: IRwcHtmlElement", "Properties", "disabled", "editMode", "Methods", "focus()" ], "name": "Interface: IRwcHtmlElement", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IRwcHtmlElement" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISearchEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISearchEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISearchEvent", "Properties", "hasResults", "searchTerm", "viewerType" ], "headings": [ "Interface: ISearchEvent", "Properties", "hasResults", "searchTerm", "viewerType" ], "name": "Interface: ISearchEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISearchEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISearchManager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISearchManager.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISearchManager", "Methods", "findAll()" ], "headings": [ "Interface: ISearchManager", "Methods", "findAll()" ], "name": "Interface: ISearchManager", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISearchManager" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISetGroupOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISetGroupOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISetGroupOptions", "Properties", "visibilityPersistenceMode?" ], "headings": [ "Interface: ISetGroupOptions", "Properties", "visibilityPersistenceMode?" ], "name": "Interface: ISetGroupOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISetGroupOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISettingGroup.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISettingGroup.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISettingGroup", "Properties", "settings", "title" ], "headings": [ "Interface: ISettingGroup", "Properties", "settings", "title" ], "name": "Interface: ISettingGroup", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISettingGroup" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISettingNote.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISettingNote.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISettingNote", "Properties", "text?", "title?" ], "headings": [ "Interface: ISettingNote", "Properties", "text?", "title?" ], "name": "Interface: ISettingNote", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISettingNote" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISettingT.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISettingT.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISetting\u0026lt;T\u0026gt;", "Type Parameters", "Properties", "defaultValue", "handlerFn()", "loadedValue?", "name", "note?", "status?", "type", "value" ], "headings": [ "Interface: ISetting\u0026lt;T\u0026gt;", "Type Parameters", "Properties", "defaultValue", "handlerFn()", "loadedValue?", "name", "note?", "status?", "type", "value" ], "name": "Interface: ISetting\u0026lt;T\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISetting\u0026lt;T\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IShiftedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IShiftedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IShiftedEvent", "Properties", "currentIndex", "previousIndex" ], "headings": [ "Interface: IShiftedEvent", "Properties", "currentIndex", "previousIndex" ], "name": "Interface: IShiftedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IShiftedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IShortcutFieldData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IShortcutFieldData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IShortcutFieldData", "Properties", "fieldName", "fieldType" ], "headings": [ "Interface: IShortcutFieldData", "Properties", "fieldName", "fieldType" ], "name": "Interface: IShortcutFieldData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IShortcutFieldData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISkeletonShownEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISkeletonShownEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISkeletonShownEvent", "Properties", "item", "skeletonType", "viewerType" ], "headings": [ "Interface: ISkeletonShownEvent", "Properties", "item", "skeletonType", "viewerType" ], "name": "Interface: ISkeletonShownEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISkeletonShownEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISmartHighlightExtensionConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISmartHighlightExtensionConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISmartHighlightExtensionConfig", "Properties", "cardId", "id", "onRender()", "order", "supportedViewers" ], "headings": [ "Interface: ISmartHighlightExtensionConfig", "Properties", "cardId", "id", "onRender()", "order", "supportedViewers" ], "name": "Interface: ISmartHighlightExtensionConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISmartHighlightExtensionConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISmartHighlightsApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISmartHighlightsApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISmartHighlightsApi", "Methods", "addFirstTerm()", "addHighlight()", "addTerm()", "createHighlightSet()" ], "headings": [ "Interface: ISmartHighlightsApi", "Methods", "addFirstTerm()", "addHighlight()", "addTerm()", "createHighlightSet()" ], "name": "Interface: ISmartHighlightsApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISmartHighlightsApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISmartHighlightsDocumentLoadDetails.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISmartHighlightsDocumentLoadDetails.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISmartHighlightsDocumentLoadDetails", "Properties", "documentId", "workspaceId" ], "headings": [ "Interface: ISmartHighlightsDocumentLoadDetails", "Properties", "documentId", "workspaceId" ], "name": "Interface: ISmartHighlightsDocumentLoadDetails", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISmartHighlightsDocumentLoadDetails" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISortIdentifier.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ISortIdentifier.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ISortIdentifier", "Properties", "Direction", "FieldIdentifier", "Order?" ], "headings": [ "Interface: ISortIdentifier", "Properties", "Direction", "FieldIdentifier", "Order?" ], "name": "Interface: ISortIdentifier", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ISortIdentifier" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ITextData", "Properties", "redactionText", "redactionTextColor?", "redactionTextFontName?", "redactionTextSize?", "redactionTextStyle?" ], "headings": [ "Interface: ITextData", "Properties", "redactionText", "redactionTextColor?", "redactionTextFontName?", "redactionTextSize?", "redactionTextStyle?" ], "name": "Interface: ITextData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ITextData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearch.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearch.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ITextSearch", "Methods", "next()" ], "headings": [ "Interface: ITextSearch", "Methods", "next()" ], "name": "Interface: ITextSearch", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ITextSearch" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchHit.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchHit.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ITextSearchHit", "Properties", "end", "start", "terms" ], "headings": [ "Interface: ITextSearchHit", "Properties", "end", "start", "terms" ], "name": "Interface: ITextSearchHit", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ITextSearchHit" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchOptions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchOptions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ITextSearchOptions", "Properties", "caseSensitive?", "direction?", "normalizeAccentsForSearch?", "normalizeEmoji?", "searchMode?", "start?", "stemAll?", "stemmer?" ], "headings": [ "Interface: ITextSearchOptions", "Properties", "caseSensitive?", "direction?", "normalizeAccentsForSearch?", "normalizeEmoji?", "searchMode?", "start?", "stemAll?", "stemmer?" ], "name": "Interface: ITextSearchOptions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ITextSearchOptions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchTermHit.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchTermHit.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ITextSearchTermHit", "Properties", "end", "start", "term" ], "headings": [ "Interface: ITextSearchTermHit", "Properties", "end", "start", "term" ], "name": "Interface: ITextSearchTermHit", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ITextSearchTermHit" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchUtilities.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextSearchUtilities.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ITextSearchUtilities", "Methods", "searchStaticText()" ], "headings": [ "Interface: ITextSearchUtilities", "Methods", "searchStaticText()" ], "name": "Interface: ITextSearchUtilities", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ITextSearchUtilities" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextUtilities.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITextUtilities.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ITextUtilities", "Properties", "search" ], "headings": [ "Interface: ITextUtilities", "Properties", "search" ], "name": "Interface: ITextUtilities", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ITextUtilities" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbar.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbar.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolbar", "Properties", "allControls", "centerControls", "class", "controlsHidden", "id", "leftControls", "overflow", "permissionCheck?", "rightControls", "title", "Methods", "addControl()", "createToolbarControl()", "disableAllControls()", "enableAllControls()", "getControlById()", "hideAllControls()", "removeControl()", "removeControlById()", "showAllControls()", "toggleList()" ], "headings": [ "Interface: IToolbar", "Properties", "allControls", "centerControls", "class", "controlsHidden", "id", "leftControls", "overflow", "permissionCheck?", "rightControls", "title", "Methods", "addControl()", "createToolbarControl()", "disableAllControls()", "enableAllControls()", "getControlById()", "hideAllControls()", "removeControl()", "removeControlById()", "showAllControls()", "toggleList()" ], "name": "Interface: IToolbar", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolbar" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarButtonControlConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarButtonControlConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolbarButtonControlConfig", "Extends", "Properties", "class", "disable()?", "enable()?", "enableOnCreation?", "id", "imageUrl", "onClick()", "permissionCheck?", "title", "type" ], "headings": [ "Interface: IToolbarButtonControlConfig", "Extends", "Properties", "class", "disable()?", "enable()?", "enableOnCreation?", "id", "imageUrl", "onClick()", "permissionCheck?", "title", "type" ], "name": "Interface: IToolbarButtonControlConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolbarButtonControlConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarControl.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarControl.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolbarControl", "Extended by", "Properties", "ariaLabel?", "class", "disabled", "id", "isControlCollection", "isFlexible", "isHidden", "order", "permissionCheck?", "role?", "scrollDimensions", "title", "viewModelPath", "Methods", "disable()", "enable()", "hide()", "show()" ], "headings": [ "Interface: IToolbarControl", "Extended by", "Properties", "ariaLabel?", "class", "disabled", "id", "isControlCollection", "isFlexible", "isHidden", "order", "permissionCheck?", "role?", "scrollDimensions", "title", "viewModelPath", "Methods", "disable()", "enable()", "hide()", "show()" ], "name": "Interface: IToolbarControl", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolbarControl" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarControlConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarControlConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolbarControlConfig", "Extended by", "Properties", "class", "disable()?", "enable()?", "enableOnCreation?", "id", "permissionCheck?", "title", "type" ], "headings": [ "Interface: IToolbarControlConfig", "Extended by", "Properties", "class", "disable()?", "enable()?", "enableOnCreation?", "id", "permissionCheck?", "title", "type" ], "name": "Interface: IToolbarControlConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolbarControlConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarControlsEnabledEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarControlsEnabledEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolbarControlsEnabledEvent", "Properties", "longTextArtifactId?", "productionArtifactId?", "productionType?", "viewerType" ], "headings": [ "Interface: IToolbarControlsEnabledEvent", "Properties", "longTextArtifactId?", "productionArtifactId?", "productionType?", "viewerType" ], "name": "Interface: IToolbarControlsEnabledEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolbarControlsEnabledEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarCustomControlConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarCustomControlConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolbarCustomControlConfig", "Extends", "Properties", "class", "disable()?", "enable()?", "enableOnCreation?", "id", "innerHTML", "permissionCheck?", "title", "type" ], "headings": [ "Interface: IToolbarCustomControlConfig", "Extends", "Properties", "class", "disable()?", "enable()?", "enableOnCreation?", "id", "innerHTML", "permissionCheck?", "title", "type" ], "name": "Interface: IToolbarCustomControlConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolbarCustomControlConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarOverflow.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarOverflow.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolbarOverflow", "Properties", "centerControls", "combinedControls", "leftControls", "rightControls", "title", "visible" ], "headings": [ "Interface: IToolbarOverflow", "Properties", "centerControls", "combinedControls", "leftControls", "rightControls", "title", "visible" ], "name": "Interface: IToolbarOverflow", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolbarOverflow" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarRWCButtonControlConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarRWCButtonControlConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolbarRWCButtonControlConfig", "Extends", "Properties", "class", "disable()?", "enable()?", "enableOnCreation?", "icon", "id", "onClick()", "permissionCheck?", "theme", "title", "type", "wrapperClass" ], "headings": [ "Interface: IToolbarRWCButtonControlConfig", "Extends", "Properties", "class", "disable()?", "enable()?", "enableOnCreation?", "icon", "id", "onClick()", "permissionCheck?", "theme", "title", "type", "wrapperClass" ], "name": "Interface: IToolbarRWCButtonControlConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolbarRWCButtonControlConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarRWCToggleControlConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarRWCToggleControlConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolbarRWCToggleControlConfig", "Extends", "Properties", "active", "class", "disable()?", "enable()?", "enableOnCreation?", "icon", "id", "onClick()", "permissionCheck?", "title", "type" ], "headings": [ "Interface: IToolbarRWCToggleControlConfig", "Extends", "Properties", "active", "class", "disable()?", "enable()?", "enableOnCreation?", "icon", "id", "onClick()", "permissionCheck?", "title", "type" ], "name": "Interface: IToolbarRWCToggleControlConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolbarRWCToggleControlConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolbarService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolbarService", "Properties", "allToolbars", "Methods", "createToolbarControl()", "getToolbarById()" ], "headings": [ "Interface: IToolbarService", "Properties", "allToolbars", "Methods", "createToolbarControl()", "getToolbarById()" ], "name": "Interface: IToolbarService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolbarService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolTipConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IToolTipConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IToolTipConfig", "Properties", "toolTipContent", "toolTipPosition" ], "headings": [ "Interface: IToolTipConfig", "Properties", "toolTipContent", "toolTipPosition" ], "name": "Interface: IToolTipConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IToolTipConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITransientHighlightManagerApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITransientHighlightManagerApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ITransientHighlightManagerApi", "Remarks", "Extended by", "Methods", "addHighlight()", "addHighlightTooltip()", "addTerm()", "addTermWithContext()", "createSet()", "deselectAllAnnotations()", "disableAutoHighlight()", "doesSetExist()", "enableAutoHighlight()", "getSelectedAnnotations()", "goToFirst()", "goToHighlight()", "goToLast()", "goToNext()", "goToPrev()", "highlightTerm()", "highlightTermWithContext()", "removeHighlight()", "removeHighlightSet()", "removeHighlightTooltip()", "selectAnnotation()", "serialize()", "setHighlightSetVisibility()", "setHighlightVisibility()", "toggleHighlightSetVisibility()", "toggleHighlightVisibility()" ], "headings": [ "Interface: ITransientHighlightManagerApi", "Remarks", "Extended by", "Methods", "addHighlight()", "addHighlightTooltip()", "addTerm()", "addTermWithContext()", "createSet()", "deselectAllAnnotations()", "disableAutoHighlight()", "doesSetExist()", "enableAutoHighlight()", "getSelectedAnnotations()", "goToFirst()", "goToHighlight()", "goToLast()", "goToNext()", "goToPrev()", "highlightTerm()", "highlightTermWithContext()", "removeHighlight()", "removeHighlightSet()", "removeHighlightTooltip()", "selectAnnotation()", "serialize()", "setHighlightSetVisibility()", "setHighlightVisibility()", "toggleHighlightSetVisibility()", "toggleHighlightVisibility()" ], "name": "Interface: ITransientHighlightManagerApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ITransientHighlightManagerApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITransientHighlightManagerEventApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_ITransientHighlightManagerEventApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: ITransientHighlightManagerEventApi", "Remarks", "Methods", "offadd()", "offclick()", "offdone()", "offHighlightActiveChange()", "offHighlightVisibilityChange()", "offmove()", "offremove()", "onadd()", "onclick()", "ondone()", "onHighlightActiveChange()", "onHighlightVisibilityChange()", "onmove()", "onremove()" ], "headings": [ "Interface: ITransientHighlightManagerEventApi", "Remarks", "Methods", "offadd()", "offclick()", "offdone()", "offHighlightActiveChange()", "offHighlightVisibilityChange()", "offmove()", "offremove()", "onadd()", "onclick()", "ondone()", "onHighlightActiveChange()", "onHighlightVisibilityChange()", "onmove()", "onremove()" ], "name": "Interface: ITransientHighlightManagerEventApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: ITransientHighlightManagerEventApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUpdateApprovedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUpdateApprovedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IUpdateApprovedEvent", "Properties", "currentIndex", "currentLongTextArtifactId?", "currentProductionArtifactId?", "currentProductionType?", "currentType", "id", "targetIndex", "targetLongTextArtifactId?", "targetProductionArtifactId?", "targetProductionType?", "targetType" ], "headings": [ "Interface: IUpdateApprovedEvent", "Properties", "currentIndex", "currentLongTextArtifactId?", "currentProductionArtifactId?", "currentProductionType?", "currentType", "id", "targetIndex", "targetLongTextArtifactId?", "targetProductionArtifactId?", "targetProductionType?", "targetType" ], "name": "Interface: IUpdateApprovedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IUpdateApprovedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUpdatedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUpdatedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IUpdatedEvent", "Properties", "currentIndex", "currentLongTextArtifactId?", "currentProductionArtifactId?", "currentProductionType?", "currentType", "id", "previousIndex", "previousLongTextArtifactId?", "previousProductionArtifactId?", "previousProductionType?", "previousType" ], "headings": [ "Interface: IUpdatedEvent", "Properties", "currentIndex", "currentLongTextArtifactId?", "currentProductionArtifactId?", "currentProductionType?", "currentType", "id", "previousIndex", "previousLongTextArtifactId?", "previousProductionArtifactId?", "previousProductionType?", "previousType" ], "name": "Interface: IUpdatedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IUpdatedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUpdateRequestedEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUpdateRequestedEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IUpdateRequestedEvent", "Properties", "changePointer?", "currentIndex", "currentLongTextArtifactId?", "currentProductionArtifactId?", "currentProductionType?", "currentType", "targetIndex", "targetLongTextArtifactId?", "targetProductionArtifactId?", "targetProductionType?", "targetType" ], "headings": [ "Interface: IUpdateRequestedEvent", "Properties", "changePointer?", "currentIndex", "currentLongTextArtifactId?", "currentProductionArtifactId?", "currentProductionType?", "currentType", "targetIndex", "targetLongTextArtifactId?", "targetProductionArtifactId?", "targetProductionType?", "targetType" ], "name": "Interface: IUpdateRequestedEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IUpdateRequestedEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUserPreferencesApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUserPreferencesApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IUserPreferencesApi", "Methods", "save()" ], "headings": [ "Interface: IUserPreferencesApi", "Methods", "save()" ], "name": "Interface: IUserPreferencesApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IUserPreferencesApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUtilitiesApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IUtilitiesApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IUtilitiesApi", "Properties", "text", "Methods", "exportToCsv()", "getCache()", "getHttpClient()" ], "headings": [ "Interface: IUtilitiesApi", "Properties", "text", "Methods", "exportToCsv()", "getCache()", "getHttpClient()" ], "name": "Interface: IUtilitiesApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IUtilitiesApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IVersionInformation.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IVersionInformation.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IVersionInformation", "Properties", "buildType", "oiVersion", "version" ], "headings": [ "Interface: IVersionInformation", "Properties", "buildType", "oiVersion", "version" ], "name": "Interface: IVersionInformation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IVersionInformation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCard.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCard.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerCard", "Extends", "Properties", "active", "activeFlag", "applicationWindow", "autoRestore", "bottomToolbar?", "cardError", "config", "defaultHeight?", "defaultWidth?", "dockSkeletonClassName", "element?", "enabled", "errorString?", "frame?", "hasError", "hasNotification", "height?", "icon", "id", "instance", "instanceId", "instanceIndex", "leftToolbar?", "loadDeferred", "location?", "maximized", "minHeight", "minWidth", "order", "overlay?", "parameters?", "popoutInProgress", "poppedIn", "poppedOut", "rightToolbar?", "skeletonVisible", "status", "title", "toolbars?", "topToolbar?", "viewerCollection", "viewerTab", "viewerToolbar?", "viewerType", "visible", "width?", "window", "Methods", "activate()", "bindInstance()", "canDeactivate()", "completeFrameLoad()", "createBanner()", "createHtmlBanner()", "createToolbar()", "deactivate()", "disable()", "dismissBanner()", "dismissBannerByClass()", "enable()", "failFrameLoad()", "hideOverlay()", "hideSkeleton()", "load()", "maximize()", "move()", "popin()", "popout()", "remove()", "reportError()", "restore()", "resumeMinHeight()", "setActiveFlag()", "setStatus()", "showNotificationDot()", "showOverlay()", "showSkeleton()", "stateChanged()", "suspendMinHeight()", "unload()", "updateLayout()", "waitForDetachment()" ], "headings": [ "Interface: IViewerCard", "Extends", "Properties", "active", "activeFlag", "applicationWindow", "autoRestore", "bottomToolbar?", "cardError", "config", "defaultHeight?", "defaultWidth?", "dockSkeletonClassName", "element?", "enabled", "errorString?", "frame?", "hasError", "hasNotification", "height?", "icon", "id", "instance", "instanceId", "instanceIndex", "leftToolbar?", "loadDeferred", "location?", "maximized", "minHeight", "minWidth", "order", "overlay?", "parameters?", "popoutInProgress", "poppedIn", "poppedOut", "rightToolbar?", "skeletonVisible", "status", "title", "toolbars?", "topToolbar?", "viewerCollection", "viewerTab", "viewerToolbar?", "viewerType", "visible", "width?", "window", "Methods", "activate()", "bindInstance()", "canDeactivate()", "completeFrameLoad()", "createBanner()", "createHtmlBanner()", "createToolbar()", "deactivate()", "disable()", "dismissBanner()", "dismissBannerByClass()", "enable()", "failFrameLoad()", "hideOverlay()", "hideSkeleton()", "load()", "maximize()", "move()", "popin()", "popout()", "remove()", "reportError()", "restore()", "resumeMinHeight()", "setActiveFlag()", "setStatus()", "showNotificationDot()", "showOverlay()", "showSkeleton()", "stateChanged()", "suspendMinHeight()", "unload()", "updateLayout()", "waitForDetachment()" ], "name": "Interface: IViewerCard", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerCard" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCardConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCardConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerCardConfig", "Extends", "Properties", "appGuid?", "appVersion?", "autoRestore?", "category?", "categoryOrder?", "defaultHeight?", "defaultWidth?", "extends?", "icon?", "id", "loader", "location?", "minHeight?", "minWidth?", "order?", "overrideViewerType?", "singleton?", "skeleton?", "supportsPopout?", "title", "toolbarsConfig?", "toolTipConfig?", "viewerToolbarConfig?", "viewerType", "Methods", "createInstance()", "supportsItem()" ], "headings": [ "Interface: IViewerCardConfig", "Extends", "Properties", "appGuid?", "appVersion?", "autoRestore?", "category?", "categoryOrder?", "defaultHeight?", "defaultWidth?", "extends?", "icon?", "id", "loader", "location?", "minHeight?", "minWidth?", "order?", "overrideViewerType?", "singleton?", "skeleton?", "supportsPopout?", "title", "toolbarsConfig?", "toolTipConfig?", "viewerToolbarConfig?", "viewerType", "Methods", "createInstance()", "supportsItem()" ], "name": "Interface: IViewerCardConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerCardConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCardInstance.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCardInstance.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerCardInstance", "Extends", "Extended by", "Properties", "cardActivated()?", "cardBuildTabOptions()?", "cardBuildToolbarOptions()?", "cardCanDeactivate()?", "cardCreateUnsupportedOverlayCard()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?", "id", "type", "unsupportedTabTitle?", "Methods", "cardLoadItem()" ], "headings": [ "Interface: IViewerCardInstance", "Extends", "Extended by", "Properties", "cardActivated()?", "cardBuildTabOptions()?", "cardBuildToolbarOptions()?", "cardCanDeactivate()?", "cardCreateUnsupportedOverlayCard()?", "cardDeactivated()?", "cardError()?", "cardLoaded()?", "cardLoadState()?", "cardMaximized()?", "cardResized()?", "cardRestored()?", "cardSaveState()?", "cardUnloaded()?", "id", "type", "unsupportedTabTitle?", "Methods", "cardLoadItem()" ], "name": "Interface: IViewerCardInstance", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerCardInstance" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCardTabOption.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCardTabOption.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerCardTabOption", "Properties", "action()", "id", "selected?", "title" ], "headings": [ "Interface: IViewerCardTabOption", "Properties", "action()", "id", "selected?", "title" ], "name": "Interface: IViewerCardTabOption", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerCardTabOption" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerChoice.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerChoice.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerChoice", "Properties", "action()", "isEnabled", "isVisible", "label", "viewerType" ], "headings": [ "Interface: IViewerChoice", "Properties", "action()", "isEnabled", "isVisible", "label", "viewerType" ], "name": "Interface: IViewerChoice", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerChoice" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCollection.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCollection.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerCollection", "Extends", "Properties", "activeType", "activeViewer", "bottomToolbar", "card", "codingCards?", "contentHighlighting", "contentType", "currentDocumentMetric", "hasActiveViewer", "id", "isBootstrapped", "isNavigating", "leftToolbar", "pageLayout", "queuePointer", "queuePointerStack", "rightToolbar", "supportedViewerTypes", "zoom", "Methods", "getDockLocation()", "getPublicDocumentData()", "getViewer()", "getViewerCard()", "off()", "on()", "once()", "popQueuePointer()", "reload()", "setQueuePointer()", "switchToQueuePointerById()", "switchToQueuePointerByIndex()" ], "headings": [ "Interface: IViewerCollection", "Extends", "Properties", "activeType", "activeViewer", "bottomToolbar", "card", "codingCards?", "contentHighlighting", "contentType", "currentDocumentMetric", "hasActiveViewer", "id", "isBootstrapped", "isNavigating", "leftToolbar", "pageLayout", "queuePointer", "queuePointerStack", "rightToolbar", "supportedViewerTypes", "zoom", "Methods", "getDockLocation()", "getPublicDocumentData()", "getViewer()", "getViewerCard()", "off()", "on()", "once()", "popQueuePointer()", "reload()", "setQueuePointer()", "switchToQueuePointerById()", "switchToQueuePointerByIndex()" ], "name": "Interface: IViewerCollection", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerCollection" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCollectionPageLayoutApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCollectionPageLayoutApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerCollectionPageLayoutApi", "Properties", "mode", "Methods", "buildPageLayoutModeControls()" ], "headings": [ "Interface: IViewerCollectionPageLayoutApi", "Properties", "mode", "Methods", "buildPageLayoutModeControls()" ], "name": "Interface: IViewerCollectionPageLayoutApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerCollectionPageLayoutApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCollectionZoomApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerCollectionZoomApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerCollectionZoomApi", "Properties", "level", "mode", "Methods", "buildZoomControls()", "buildZoomFitControls()", "updateZoom()" ], "headings": [ "Interface: IViewerCollectionZoomApi", "Properties", "level", "mode", "Methods", "buildZoomControls()", "buildZoomFitControls()", "updateZoom()" ], "name": "Interface: IViewerCollectionZoomApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerCollectionZoomApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerContentKeyCacheManager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerContentKeyCacheManager.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerContentKeyCacheManager", "Methods", "tryClearCacheForDocumentAndType()", "tryClearCacheForQueueItemAndType()" ], "headings": [ "Interface: IViewerContentKeyCacheManager", "Methods", "tryClearCacheForDocumentAndType()", "tryClearCacheForQueueItemAndType()" ], "name": "Interface: IViewerContentKeyCacheManager", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerContentKeyCacheManager" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerHighlightManager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerHighlightManager.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerHighlightManager", "Properties", "activeSearch", "Methods", "addTerms()", "changeSetExpanded()", "changeSetVisibility()", "changeTermVisibility()", "cleanupPersistentHighlights()", "clearRecentSearchSet()", "clearRecentSearchTerm()", "clearSearch()", "findFirstSearchTerm()", "findNextSearchTerm()", "findPreviousSearchTerm()", "navigateToNextHighlight()", "navigateToPrevHighlight()", "refresh()", "selectSet()", "selectTerm()", "toggleDrawer()", "unselectAll()" ], "headings": [ "Interface: IViewerHighlightManager", "Properties", "activeSearch", "Methods", "addTerms()", "changeSetExpanded()", "changeSetVisibility()", "changeTermVisibility()", "cleanupPersistentHighlights()", "clearRecentSearchSet()", "clearRecentSearchTerm()", "clearSearch()", "findFirstSearchTerm()", "findNextSearchTerm()", "findPreviousSearchTerm()", "navigateToNextHighlight()", "navigateToPrevHighlight()", "refresh()", "selectSet()", "selectTerm()", "toggleDrawer()", "unselectAll()" ], "name": "Interface: IViewerHighlightManager", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerHighlightManager" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerMenu.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerMenu.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerMenu", "Properties", "viewerChoices" ], "headings": [ "Interface: IViewerMenu", "Properties", "viewerChoices" ], "name": "Interface: IViewerMenu", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerMenu" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerObjects.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerObjects.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerObjects", "Properties", "designations?", "highlights?", "hyperlinks?", "selection?" ], "headings": [ "Interface: IViewerObjects", "Properties", "designations?", "highlights?", "hyperlinks?", "selection?" ], "name": "Interface: IViewerObjects", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerObjects" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerSearch.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerSearch.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerSearch", "Properties", "hasResults", "searchTerm" ], "headings": [ "Interface: IViewerSearch", "Properties", "hasResults", "searchTerm" ], "name": "Interface: IViewerSearch", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerSearch" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerService", "Extends", "Properties", "count", "mainCollection", "Methods", "get()", "off()", "on()", "once()", "remove()" ], "headings": [ "Interface: IViewerService", "Extends", "Properties", "count", "mainCollection", "Methods", "get()", "off()", "on()", "once()", "remove()" ], "name": "Interface: IViewerService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerSettingsService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewerSettingsService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewerSettingsService", "Methods", "hide()", "show()" ], "headings": [ "Interface: IViewerSettingsService", "Methods", "hide()", "show()" ], "name": "Interface: IViewerSettingsService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewerSettingsService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewModelCardLoader.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IViewModelCardLoader.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IViewModelCardLoader", "Properties", "autoResolveLoad?", "viewModelPath?", "viewPath?" ], "headings": [ "Interface: IViewModelCardLoader", "Properties", "autoResolveLoad?", "viewModelPath?", "viewPath?" ], "name": "Interface: IViewModelCardLoader", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IViewModelCardLoader" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IWindowService.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IWindowService.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IWindowService", "Properties", "all", "main", "relativity", "Methods", "closeAll()", "create()", "getWindow()" ], "headings": [ "Interface: IWindowService", "Properties", "all", "main", "relativity", "Methods", "closeAll()", "create()", "getWindow()" ], "name": "Interface: IWindowService", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IWindowService" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IZoomApi.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IZoomApi.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IZoomApi", "Methods", "resetZoom()", "zoomIn()", "zoomLevel()", "zoomOut()", "zoomToFit()", "zoomToIndex()" ], "headings": [ "Interface: IZoomApi", "Methods", "resetZoom()", "zoomIn()", "zoomLevel()", "zoomOut()", "zoomToFit()", "zoomToIndex()" ], "name": "Interface: IZoomApi", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IZoomApi" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IZoomControlCollection.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IZoomControlCollection.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IZoomControlCollection", "Extends", "Properties", "ariaLabel?", "class", "controls", "disabled", "id", "isControlCollection", "isFlexible", "isHidden", "leftDivider", "order", "permissionCheck?", "rightDivider", "role?", "scrollDimensions", "title", "viewModelPath", "Methods", "addControl()", "addZoomControl()", "disable()", "enable()", "getControlById()", "hide()", "removeControl()", "removeZoomControl()", "setZoomLevel()", "show()" ], "headings": [ "Interface: IZoomControlCollection", "Extends", "Properties", "ariaLabel?", "class", "controls", "disabled", "id", "isControlCollection", "isFlexible", "isHidden", "leftDivider", "order", "permissionCheck?", "rightDivider", "role?", "scrollDimensions", "title", "viewModelPath", "Methods", "addControl()", "addZoomControl()", "disable()", "enable()", "getControlById()", "hide()", "removeControl()", "removeZoomControl()", "setZoomLevel()", "show()" ], "name": "Interface: IZoomControlCollection", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IZoomControlCollection" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IZoomEvent.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_IZoomEvent.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: IZoomEvent", "Properties", "zoomIndex", "zoomMode" ], "headings": [ "Interface: IZoomEvent", "Properties", "zoomIndex", "zoomMode" ], "name": "Interface: IZoomEvent", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: IZoomEvent" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_LineRangeMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_LineRangeMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: LineRangeMemento", "Properties", "endLineIndex", "endOffset", "endPageIndex", "startLineIndex", "startOffset", "startPageIndex", "type" ], "headings": [ "Interface: LineRangeMemento", "Properties", "endLineIndex", "endOffset", "endPageIndex", "startLineIndex", "startOffset", "startPageIndex", "type" ], "name": "Interface: LineRangeMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: LineRangeMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_LinkOption.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_LinkOption.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: LinkOption", "Properties", "linkClass?", "linkText", "onClick()" ], "headings": [ "Interface: LinkOption", "Properties", "linkClass?", "linkText", "onClick()" ], "name": "Interface: LinkOption", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: LinkOption" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_RectangleOffsets.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_RectangleOffsets.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: RectangleOffsets", "Properties", "bottom", "left", "right", "top" ], "headings": [ "Interface: RectangleOffsets", "Properties", "bottom", "left", "right", "top" ], "name": "Interface: RectangleOffsets", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: RectangleOffsets" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_RectRangeMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_RectRangeMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: RectRangeMemento", "Properties", "bottom", "embedId?", "hdpi?", "left", "page", "right", "section?", "top", "type", "units", "vdpi?" ], "headings": [ "Interface: RectRangeMemento", "Properties", "bottom", "embedId?", "hdpi?", "left", "page", "right", "section?", "top", "type", "units", "vdpi?" ], "name": "Interface: RectRangeMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: RectRangeMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_SetGroupMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_SetGroupMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: SetGroupMemento", "Properties", "id", "sets", "visibilityPersistenceMode", "visible" ], "headings": [ "Interface: SetGroupMemento", "Properties", "id", "sets", "visibilityPersistenceMode", "visible" ], "name": "Interface: SetGroupMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: SetGroupMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextRangeMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextRangeMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: TextRangeMemento", "Properties", "acc", "accend", "type" ], "headings": [ "Interface: TextRangeMemento", "Properties", "acc", "accend", "type" ], "name": "Interface: TextRangeMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: TextRangeMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: TextSearchConfig", "Extended by", "Properties", "caseSensitive", "normalizeAccentsForSearch", "normalizeEmoji", "searchMode", "stemAll", "stemmer" ], "headings": [ "Interface: TextSearchConfig", "Extended by", "Properties", "caseSensitive", "normalizeAccentsForSearch", "normalizeEmoji", "searchMode", "stemAll", "stemmer" ], "name": "Interface: TextSearchConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: TextSearchConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchResult.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchResult.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: TextSearchResult", "Properties", "range", "selected?", "terms?" ], "headings": [ "Interface: TextSearchResult", "Properties", "range", "selected?", "terms?" ], "name": "Interface: TextSearchResult", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: TextSearchResult" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchResultTerm.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchResultTerm.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: TextSearchResultTerm", "Properties", "range", "term" ], "headings": [ "Interface: TextSearchResultTerm", "Properties", "range", "term" ], "name": "Interface: TextSearchResultTerm", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: TextSearchResultTerm" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchTerm.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TextSearchTerm.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: TextSearchTerm", "Extends", "Properties", "caseSensitive", "context?", "normalizeAccentsForSearch", "normalizeEmoji", "searchMode", "stemAll", "stemmer", "term", "termMetadata?" ], "headings": [ "Interface: TextSearchTerm", "Extends", "Properties", "caseSensitive", "context?", "normalizeAccentsForSearch", "normalizeEmoji", "searchMode", "stemAll", "stemmer", "term", "termMetadata?" ], "name": "Interface: TextSearchTerm", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: TextSearchTerm" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TimeRangeMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TimeRangeMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: TimeRangeMemento", "Properties", "begin", "end", "page", "type" ], "headings": [ "Interface: TimeRangeMemento", "Properties", "begin", "end", "page", "type" ], "name": "Interface: TimeRangeMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: TimeRangeMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TooltipMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_TooltipMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: TooltipMemento", "Properties", "_oiTooltip", "icon?", "text" ], "headings": [ "Interface: TooltipMemento", "Properties", "_oiTooltip", "icon?", "text" ], "name": "Interface: TooltipMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: TooltipMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_UserDataMap.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Interface_UserDataMap.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Interface: UserDataMap", "Indexable" ], "headings": [ "Interface: UserDataMap", "Indexable" ], "name": "Interface: UserDataMap", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Interface: UserDataMap" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Internal.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Internal.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Internal", "Index", "Interfaces" ], "headings": [ "Internal", "Index", "Interfaces" ], "name": "Internal", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Internal" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ItemList.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ItemList.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ItemList", "Index", "Interfaces", "Type Aliases" ], "headings": [ "ItemList", "Index", "Interfaces", "Type Aliases" ], "name": "ItemList", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ItemList" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/KeyboardShortcuts.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/KeyboardShortcuts.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "KeyboardShortcuts", "Index", "Enumerations", "Interfaces" ], "headings": [ "KeyboardShortcuts", "Index", "Enumerations", "Interfaces" ], "name": "KeyboardShortcuts", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "KeyboardShortcuts" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Lifecycle.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Lifecycle.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Lifecycle", "Index", "Enumerations", "Interfaces" ], "headings": [ "Lifecycle", "Index", "Enumerations", "Interfaces" ], "name": "Lifecycle", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Lifecycle" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Loading_Queue_Items.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Loading_Queue_Items.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Loading Queue Items", "Parameters for cardLoadItem method", "item", "options", "Handle a cancellation", "Handle errors" ], "headings": [ "Loading Queue Items", "Parameters for cardLoadItem method", "item", "options", "Handle a cancellation", "Handle errors" ], "name": "Loading Queue Items", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Loading Queue Items" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/MassOperations.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/MassOperations.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "MassOperations", "Index", "Interfaces" ], "headings": [ "MassOperations", "Index", "Interfaces" ], "name": "MassOperations", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "MassOperations" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Migrating_Legacy_Integrations.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Migrating_Legacy_Integrations.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Migrating Legacy Integrations", "Legacy integrations", "Support for legacy HTML5 document viewer" ], "headings": [ "Migrating Legacy Integrations", "Legacy integrations", "Support for legacy HTML5 document viewer" ], "name": "Migrating Legacy Integrations", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Migrating Legacy Integrations" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Migration_Guide.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Migration_Guide.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Migration Guide", "Custom panes", "Sample legacy custom pane", "Sample migrated custom pane", "Map legacy values to a custom card", "Custom viewers", "Context menu integrations", "Document layout changes" ], "headings": [ "Migration Guide", "Custom panes", "Sample legacy custom pane", "Sample migrated custom pane", "Map legacy values to a custom card", "Custom viewers", "Context menu integrations", "Document layout changes" ], "name": "Migration Guide", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Migration Guide" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Navigation_In_Relativity_Review_Interface.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Navigation_In_Relativity_Review_Interface.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Navigation In Relativity Review Interface", "APIs for queues", "Queue items", "Creating queues", "Deleting queues", "Modifying queues", "Adding custom data to queues", "Queue events", "Queue pointers", "Sample queue use case", "Code samples for the queue pointer object" ], "headings": [ "Navigation In Relativity Review Interface", "APIs for queues", "Queue items", "Creating queues", "Deleting queues", "Modifying queues", "Adding custom data to queues", "Queue events", "Queue pointers", "Sample queue use case", "Code samples for the queue pointer object" ], "name": "Navigation In Relativity Review Interface", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Navigation In Relativity Review Interface" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Note.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Note.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Note", "Index", "Interfaces", "Type Aliases" ], "headings": [ "Note", "Index", "Interfaces", "Type Aliases" ], "name": "Note", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Note" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Notification.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Notification.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Notification", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "headings": [ "Notification", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "name": "Notification", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Notification" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Performance.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Performance.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Performance", "Index", "Interfaces", "Type Aliases" ], "headings": [ "Performance", "Index", "Interfaces", "Type Aliases" ], "name": "Performance", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Performance" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Permissions.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Permissions.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Permissions", "Index", "Interfaces" ], "headings": [ "Permissions", "Index", "Interfaces" ], "name": "Permissions", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Permissions" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Preview.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Preview.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Preview", "Index", "Enumerations", "Interfaces" ], "headings": [ "Preview", "Index", "Enumerations", "Interfaces" ], "name": "Preview", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Preview" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ProductionHistory.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ProductionHistory.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ProductionHistory", "Index", "Interfaces" ], "headings": [ "ProductionHistory", "Index", "Interfaces" ], "name": "ProductionHistory", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ProductionHistory" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Queue.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Queue.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Queue", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "headings": [ "Queue", "Index", "Enumerations", "Interfaces", "Type Aliases" ], "name": "Queue", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Queue" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/range-memento-helperrange-memento-helper-interface.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/range-memento-helperrange-memento-helper-interface.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "range-memento-helper/range-memento-helper-interface", "Index", "Interfaces" ], "headings": [ "range-memento-helper/range-memento-helper-interface", "Index", "Interfaces" ], "name": "range-memento-helper/range-memento-helper-interface", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "range-memento-helper/range-memento-helper-interface" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Redirecting_Relativity_Viewers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Redirecting_Relativity_Viewers.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Redirecting Relativity Viewers", "headings": "Redirecting Relativity Viewers", "name": "Redirecting Relativity Viewers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Redirecting Relativity Viewers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/RelatedItems.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/RelatedItems.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "RelatedItems", "Index", "Interfaces" ], "headings": [ "RelatedItems", "Index", "Interfaces" ], "name": "RelatedItems", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "RelatedItems" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Relativity_Review_API_Introduction.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Relativity_Review_API_Introduction.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Review API", "Modules" ], "headings": [ "Relativity Review API", "Modules" ], "name": "Relativity Review API", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Relativity Review API" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Relativity_Review_overview.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Relativity_Review_overview.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Review overview", "Relativity Review API suite", "Enable or disable Relativity Review" ], "headings": [ "Relativity Review overview", "Relativity Review API suite", "Enable or disable Relativity Review" ], "name": "Relativity Review overview", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Relativity Review overview" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Review_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Review_API_Reference.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Review API Reference", "Modules" ], "headings": [ "Relativity Review API Reference", "Modules" ], "name": "Relativity Review API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Relativity Review API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Sample_Viewer_Type.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Sample_Viewer_Type.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Sample Viewer Type", "headings": "Sample Viewer Type", "name": "Sample Viewer Type", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Sample Viewer Type" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Search.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Search.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Search", "Index", "Interfaces" ], "headings": [ "Search", "Index", "Interfaces" ], "name": "Search", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Search" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Settings.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Settings.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Settings", "Index", "Interfaces" ], "headings": [ "Settings", "Index", "Interfaces" ], "name": "Settings", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Settings" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/SmartHighlights.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/SmartHighlights.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "SmartHighlights", "Index", "Interfaces" ], "headings": [ "SmartHighlights", "Index", "Interfaces" ], "name": "SmartHighlights", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "SmartHighlights" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Toolbar.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Toolbar.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Toolbar", "Index", "Enumerations", "Interfaces" ], "headings": [ "Toolbar", "Index", "Enumerations", "Interfaces" ], "name": "Toolbar", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Toolbar" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Toolbars.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Toolbars.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Toolbars", "Create toolbar controls using the Review API", "Create toolbar controls in extension scripts", "Resolving image URLs for CDN-delivered extensions", "Control types", "TypeScript example (recommended: rwcbutton)", "Toggle button example (rwctogglebutton)", "Viewer-type-specific controls" ], "headings": [ "Toolbars", "Create toolbar controls using the Review API", "Create toolbar controls in extension scripts", "Resolving image URLs for CDN-delivered extensions", "Control types", "TypeScript example (recommended: rwcbutton)", "Toggle button example (rwctogglebutton)", "Viewer-type-specific controls" ], "name": "Toolbars", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Toolbars" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ToolTip.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/ToolTip.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "ToolTip", "Index", "Enumerations", "Interfaces" ], "headings": [ "ToolTip", "Index", "Enumerations", "Interfaces" ], "name": "ToolTip", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "ToolTip" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Transient_Highlights.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Transient_Highlights.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Transient Highlights", "Code samples", "Highlight sets", "Highlights", "Create a range", "Retrieve the page height and width", "Define a highlight config object", "Create a highlight", "Delete a highlight", "Interact with highlights", "Set the selection mode", "Select ranges", "Retrieve highlights", "Draw highlights", "Highlight events" ], "headings": [ "Transient Highlights", "Code samples", "Highlight sets", "Highlights", "Create a range", "Retrieve the page height and width", "Define a highlight config object", "Create a highlight", "Delete a highlight", "Interact with highlights", "Set the selection mode", "Select ranges", "Retrieve highlights", "Draw highlights", "Highlight events" ], "name": "Transient Highlights", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Transient Highlights" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_AnnotationLocation.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_AnnotationLocation.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: AnnotationLocation", "headings": "Type Alias: AnnotationLocation", "name": "Type Alias: AnnotationLocation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: AnnotationLocation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_AnnotationSubType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_AnnotationSubType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: AnnotationSubType", "headings": "Type Alias: AnnotationSubType", "name": "Type Alias: AnnotationSubType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: AnnotationSubType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ApmCustomData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ApmCustomData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: ApmCustomData", "headings": "Type Alias: ApmCustomData", "name": "Type Alias: ApmCustomData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ApmCustomData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiCustomEventHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiCustomEventHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiCustomEventHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiCustomEventHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiCustomEventHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiCustomEventHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightActiveChangeHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightActiveChangeHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiHighlightActiveChangeHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiHighlightActiveChangeHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiHighlightActiveChangeHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiHighlightActiveChangeHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightAddHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightAddHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiHighlightAddHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiHighlightAddHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiHighlightAddHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiHighlightAddHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightClickHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightClickHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiHighlightClickHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiHighlightClickHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiHighlightClickHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiHighlightClickHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightMoveHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightMoveHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiHighlightMoveHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiHighlightMoveHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiHighlightMoveHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiHighlightMoveHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightRemoveHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiHighlightRemoveHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiHighlightRemoveHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiHighlightRemoveHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiHighlightRemoveHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiHighlightRemoveHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSearchCompleteHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSearchCompleteHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiSearchCompleteHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiSearchCompleteHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiSearchCompleteHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiSearchCompleteHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSearchHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSearchHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiSearchHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiSearchHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiSearchHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiSearchHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSetAddHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSetAddHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiSetAddHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiSetAddHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiSetAddHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiSetAddHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSetRemoveHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSetRemoveHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiSetRemoveHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiSetRemoveHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiSetRemoveHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiSetRemoveHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSetVisibleChangeHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiSetVisibleChangeHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiSetVisibleChangeHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiSetVisibleChangeHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiSetVisibleChangeHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiSetVisibleChangeHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiVisibleChangeHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingApiVisibleChangeHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingApiVisibleChangeHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingApiVisibleChangeHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingApiVisibleChangeHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingApiVisibleChangeHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiContentChangeHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiContentChangeHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingCardApiContentChangeHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingCardApiContentChangeHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingCardApiContentChangeHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingCardApiContentChangeHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderAbortHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderAbortHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingCardApiRenderAbortHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingCardApiRenderAbortHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingCardApiRenderAbortHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingCardApiRenderAbortHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderCompleteHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderCompleteHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingCardApiRenderCompleteHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingCardApiRenderCompleteHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingCardApiRenderCompleteHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingCardApiRenderCompleteHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderErrorHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderErrorHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingCardApiRenderErrorHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingCardApiRenderErrorHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingCardApiRenderErrorHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingCardApiRenderErrorHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiRenderHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingCardApiRenderHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingCardApiRenderHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingCardApiRenderHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingCardApiRenderHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiVisibleChangeHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardApiVisibleChangeHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingCardApiVisibleChangeHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingCardApiVisibleChangeHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingCardApiVisibleChangeHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingCardApiVisibleChangeHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardVisibleFn__CType__CTType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingCardVisibleFn__CType__CTType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingCardVisibleFn()\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingCardVisibleFn()\u0026lt;CType, CTType\u0026gt;", "Type Parameters", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingCardVisibleFn()\u0026lt;CType, CTType\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingCardVisibleFn()\u0026lt;CType, CTType\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingServiceEnabledChangeHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingServiceEnabledChangeHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingServiceEnabledChangeHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingServiceEnabledChangeHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingServiceEnabledChangeHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingServiceEnabledChangeHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingServiceFeatureEnabledChangeHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingServiceFeatureEnabledChangeHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingServiceFeatureEnabledChangeHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingServiceFeatureEnabledChangeHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingServiceFeatureEnabledChangeHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingServiceFeatureEnabledChangeHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingServiceFeatureRegisteredHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ContentHighlightingServiceFeatureRegisteredHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ContentHighlightingServiceFeatureRegisteredHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: ContentHighlightingServiceFeatureRegisteredHandler()", "Parameters", "Returns" ], "name": "Type Alias: ContentHighlightingServiceFeatureRegisteredHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ContentHighlightingServiceFeatureRegisteredHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_CustomData.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_CustomData.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: CustomData", "headings": "Type Alias: CustomData", "name": "Type Alias: CustomData", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: CustomData" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_EventHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_EventHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: EventHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: EventHandler()", "Parameters", "Returns" ], "name": "Type Alias: EventHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: EventHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_FeatureConfigValue.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_FeatureConfigValue.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: FeatureConfigValue", "headings": "Type Alias: FeatureConfigValue", "name": "Type Alias: FeatureConfigValue", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: FeatureConfigValue" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_FontSizeOrAuto.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_FontSizeOrAuto.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: FontSizeOrAuto", "headings": "Type Alias: FontSizeOrAuto", "name": "Type Alias: FontSizeOrAuto", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: FontSizeOrAuto" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_HyperlinkRangeMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_HyperlinkRangeMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: HyperlinkRangeMemento", "headings": "Type Alias: HyperlinkRangeMemento", "name": "Type Alias: HyperlinkRangeMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: HyperlinkRangeMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ICardCustomState.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ICardCustomState.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ICardCustomState", "Index Signature" ], "headings": [ "Type Alias: ICardCustomState", "Index Signature" ], "name": "Type Alias: ICardCustomState", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ICardCustomState" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IDesignation.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IDesignation.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: IDesignation", "headings": "Type Alias: IDesignation", "name": "Type Alias: IDesignation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: IDesignation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IHyperlinkManager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IHyperlinkManager.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: IHyperlinkManager", "headings": "Type Alias: IHyperlinkManager", "name": "Type Alias: IHyperlinkManager", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: IHyperlinkManager" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_INoteManager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_INoteManager.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: INoteManager", "headings": "Type Alias: INoteManager", "name": "Type Alias: INoteManager", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: INoteManager" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IReadonlyCardConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IReadonlyCardConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: IReadonlyCardConfig", "headings": "Type Alias: IReadonlyCardConfig", "name": "Type Alias: IReadonlyCardConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: IReadonlyCardConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IReadonlyCardIcon.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IReadonlyCardIcon.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: IReadonlyCardIcon", "headings": "Type Alias: IReadonlyCardIcon", "name": "Type Alias: IReadonlyCardIcon", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: IReadonlyCardIcon" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IReadonlyViewerCardConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_IReadonlyViewerCardConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: IReadonlyViewerCardConfig", "headings": "Type Alias: IReadonlyViewerCardConfig", "name": "Type Alias: IReadonlyViewerCardConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: IReadonlyViewerCardConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ItemListFieldValueTransformFn__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ItemListFieldValueTransformFn__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ItemListFieldValueTransformFn()", "Parameters", "Returns" ], "headings": [ "Type Alias: ItemListFieldValueTransformFn()", "Parameters", "Returns" ], "name": "Type Alias: ItemListFieldValueTransformFn()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ItemListFieldValueTransformFn()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ItemListFieldValueTransformIdentificationFn__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ItemListFieldValueTransformIdentificationFn__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ItemListFieldValueTransformIdentificationFn()", "Parameters", "Returns" ], "headings": [ "Type Alias: ItemListFieldValueTransformIdentificationFn()", "Parameters", "Returns" ], "name": "Type Alias: ItemListFieldValueTransformIdentificationFn()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ItemListFieldValueTransformIdentificationFn()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ItemLoadTransformFn__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ItemLoadTransformFn__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ItemLoadTransformFn()", "Parameters", "Returns" ], "headings": [ "Type Alias: ItemLoadTransformFn()", "Parameters", "Returns" ], "name": "Type Alias: ItemLoadTransformFn()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ItemLoadTransformFn()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ITransientHighlightManager.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ITransientHighlightManager.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: ITransientHighlightManager", "Remarks" ], "headings": [ "Type Alias: ITransientHighlightManager", "Remarks" ], "name": "Type Alias: ITransientHighlightManager", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ITransientHighlightManager" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_NoteRangeMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_NoteRangeMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: NoteRangeMemento", "headings": "Type Alias: NoteRangeMemento", "name": "Type Alias: NoteRangeMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: NoteRangeMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PartialHighlightConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PartialHighlightConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: PartialHighlightConfig", "headings": "Type Alias: PartialHighlightConfig", "name": "Type Alias: PartialHighlightConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: PartialHighlightConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PartialTextSearchConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PartialTextSearchConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: PartialTextSearchConfig", "headings": "Type Alias: PartialTextSearchConfig", "name": "Type Alias: PartialTextSearchConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: PartialTextSearchConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PopupFactoryOptionsForExistingObject.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PopupFactoryOptionsForExistingObject.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: PopupFactoryOptionsForExistingObject", "Type declaration", "artifactId" ], "headings": [ "Type Alias: PopupFactoryOptionsForExistingObject", "Type declaration", "artifactId" ], "name": "Type Alias: PopupFactoryOptionsForExistingObject", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: PopupFactoryOptionsForExistingObject" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PopupFactoryOptionsForNewObject.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PopupFactoryOptionsForNewObject.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: PopupFactoryOptionsForNewObject", "Type declaration", "associatedArtifactId?", "connectorFieldArtifactId?", "parentArtifactId" ], "headings": [ "Type Alias: PopupFactoryOptionsForNewObject", "Type declaration", "associatedArtifactId?", "connectorFieldArtifactId?", "parentArtifactId" ], "name": "Type Alias: PopupFactoryOptionsForNewObject", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: PopupFactoryOptionsForNewObject" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PreReportEventHandler__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_PreReportEventHandler__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: PreReportEventHandler()", "Parameters", "Returns" ], "headings": [ "Type Alias: PreReportEventHandler()", "Parameters", "Returns" ], "name": "Type Alias: PreReportEventHandler()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: PreReportEventHandler()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_QueueItemType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_QueueItemType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: QueueItemType", "headings": "Type Alias: QueueItemType", "name": "Type Alias: QueueItemType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: QueueItemType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RangeHighlightSetConfig.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RangeHighlightSetConfig.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: RangeHighlightSetConfig", "headings": "Type Alias: RangeHighlightSetConfig", "name": "Type Alias: RangeHighlightSetConfig", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: RangeHighlightSetConfig" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RedactionTextSize.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RedactionTextSize.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: RedactionTextSize", "headings": "Type Alias: RedactionTextSize", "name": "Type Alias: RedactionTextSize", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: RedactionTextSize" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RenderContentHighlightsFn__VType__CType__CTType__CKType__CVType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RenderContentHighlightsFn__VType__CType__CTType__CKType__CVType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: RenderContentHighlightsFn()\u0026lt;VType, CType, CTType, CKType, CVType\u0026gt;", "Type Parameters", "Parameters", "Returns" ], "headings": [ "Type Alias: RenderContentHighlightsFn()\u0026lt;VType, CType, CTType, CKType, CVType\u0026gt;", "Type Parameters", "Parameters", "Returns" ], "name": "Type Alias: RenderContentHighlightsFn()\u0026lt;VType, CType, CTType, CKType, CVType\u0026gt;", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: RenderContentHighlightsFn()\u0026lt;VType, CType, CTType, CKType, CVType\u0026gt;" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RTCMessageHandlerFn__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_RTCMessageHandlerFn__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: RTCMessageHandlerFn()", "Parameters", "Returns" ], "headings": [ "Type Alias: RTCMessageHandlerFn()", "Parameters", "Returns" ], "name": "Type Alias: RTCMessageHandlerFn()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: RTCMessageHandlerFn()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_SelectionRangeMemento.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_SelectionRangeMemento.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: SelectionRangeMemento", "headings": "Type Alias: SelectionRangeMemento", "name": "Type Alias: SelectionRangeMemento", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: SelectionRangeMemento" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_SupportedCacheKeyTypeUnion.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_SupportedCacheKeyTypeUnion.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: SupportedCacheKeyTypeUnion", "headings": "Type Alias: SupportedCacheKeyTypeUnion", "name": "Type Alias: SupportedCacheKeyTypeUnion", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: SupportedCacheKeyTypeUnion" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_TextProvider__.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_TextProvider__.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Type Alias: TextProvider()", "Returns" ], "headings": [ "Type Alias: TextProvider()", "Returns" ], "name": "Type Alias: TextProvider()", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: TextProvider()" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ViewerType.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Type_Alias_ViewerType.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Type Alias: ViewerType", "headings": "Type Alias: ViewerType", "name": "Type Alias: ViewerType", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Type Alias: ViewerType" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Unsupported_Items.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Unsupported_Items.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Unsupported Items", "Viewer tabs", "Viewer card overlays" ], "headings": [ "Unsupported Items", "Viewer tabs", "Viewer card overlays" ], "name": "Unsupported Items", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Unsupported Items" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Upgrade_considerations_for_viewer_integrations.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Upgrade_considerations_for_viewer_integrations.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Upgrade considerations for viewer integrations", "Viewer technology and DOM changes", "Updated DOM structure", "Unavailable PDFTron JavaScript APIs", "Viewer integration guidelines" ], "headings": [ "Upgrade considerations for viewer integrations", "Viewer technology and DOM changes", "Updated DOM structure", "Unavailable PDFTron JavaScript APIs", "Viewer integration guidelines" ], "name": "Upgrade considerations for viewer integrations", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Upgrade considerations for viewer integrations" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/UserPreferences.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/UserPreferences.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "UserPreferences", "Index", "Interfaces" ], "headings": [ "UserPreferences", "Index", "Interfaces" ], "name": "UserPreferences", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "UserPreferences" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Using_the_Review_APIs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Using_the_Review_APIs.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Using the Review APIs", "Info API", "Viewer API", "Access the viewer instance", "Markups" ], "headings": [ "Using the Review APIs", "Info API", "Viewer API", "Access the viewer instance", "Markups" ], "name": "Using the Review APIs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Using the Review APIs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Using_TypeScript.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Using_TypeScript.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Using TypeScript", "Benefits of TypeScript", "Consuming the Review API package", "Install the Review API package", "Import from the Review API package", "Version pinning", "Updating the reviewapi version" ], "headings": [ "Using TypeScript", "Benefits of TypeScript", "Consuming the Review API package", "Install the Review API package", "Import from the Review API package", "Version pinning", "Updating the reviewapi version" ], "name": "Using TypeScript", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Using TypeScript" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Utilities.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Utilities.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Utilities", "Index", "Enumerations", "Interfaces", "Type Aliases", "Functions" ], "headings": [ "Utilities", "Index", "Enumerations", "Interfaces", "Type Aliases", "Functions" ], "name": "Utilities", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Utilities" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Version.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Version.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Version", "Index", "Interfaces" ], "headings": [ "Version", "Index", "Interfaces" ], "name": "Version", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Version" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Viewer", "Index", "Model / Text", "Other", "View Highlight" ], "headings": [ "Viewer", "Index", "Model / Text", "Other", "View Highlight" ], "name": "Viewer", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Viewer" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Architecture.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Architecture.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Viewer Architecture", "Viewer type", "Viewer type sub-components", "Viewer collection" ], "headings": [ "Viewer Architecture", "Viewer type", "Viewer type sub-components", "Viewer collection" ], "name": "Viewer Architecture", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Viewer Architecture" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Context_Menus.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Context_Menus.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Viewer Context Menus", "headings": "Viewer Context Menus", "name": "Viewer Context Menus", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Viewer Context Menus" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Events.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Events.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Viewer Events", "Viewer collection events", "Where to register collection event handlers", "Registering collection event handlers", "contentchanged", "contentchanging", "contentchangeapproved", "activeViewerChanged", "documentMetaDataChanged", "Other collection events", "Individual viewer events", "Register viewer event handlers", "Common events" ], "headings": [ "Viewer Events", "Viewer collection events", "Where to register collection event handlers", "Registering collection event handlers", "contentchanged", "contentchanging", "contentchangeapproved", "activeViewerChanged", "documentMetaDataChanged", "Other collection events", "Individual viewer events", "Register viewer event handlers", "Common events" ], "name": "Viewer Events", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Viewer Events" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Tabs.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewer_Tabs.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Viewer Tabs", "Tab visibility", "Full mode", "Limited mode", "Overriding core viewer types" ], "headings": [ "Viewer Tabs", "Tab visibility", "Full mode", "Limited mode", "Overriding core viewer types" ], "name": "Viewer Tabs", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Viewer Tabs" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewers.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Viewers.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Viewers", "Core viewer types", "Custom viewer types" ], "headings": [ "Viewers", "Core viewer types", "Custom viewer types" ], "name": "Viewers", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Viewers" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Window.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Window.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Window", "Index", "Enumerations", "Interfaces" ], "headings": [ "Window", "Index", "Enumerations", "Interfaces" ], "name": "Window", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Window" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Window_Service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Window_Service.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Window Service", "Create pop-up windows using the Window Service API", "Subscribe to window events", "Access the main and Relativity windows", "Access a pop-up window by name", "Close all pop-up windows" ], "headings": [ "Window Service", "Create pop-up windows using the Window Service API", "Subscribe to window events", "Access the main and Relativity windows", "Access a pop-up window by name", "Close all pop-up windows" ], "name": "Window Service", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Window Service" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Zoom.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/ReviewAPI/Zoom.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Zoom", "Index", "Interfaces" ], "headings": [ "Zoom", "Index", "Interfaces" ], "name": "Zoom", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Zoom" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Folder_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Folder_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Folder Manager (.NET)", "Folder Manager service", "Accessing the Folder Manager service", "Create a folder", "Update a folder", "Delete unused folders", "Query for folders", "Helper methods", "Retrieve the root Folder for a workspace", "Retrieve subfolders", "Retrieve expanded Folder nodes", "Retrieve ancestors of a Folder", "Get access status for a Folder", "Move Folders" ], "headings": [ "Folder Manager (.NET)", "Folder Manager service", "Accessing the Folder Manager service", "Create a folder", "Update a folder", "Delete unused folders", "Query for folders", "Helper methods", "Retrieve the root Folder for a workspace", "Retrieve subfolders", "Retrieve expanded Folder nodes", "Retrieve ancestors of a Folder", "Get access status for a Folder", "Move Folders" ], "name": "Folder Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Folder Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Logging_Interfaces_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Logging_Interfaces_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.Logging.Interfaces namespace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Logging Interfaces .NET API Reference", "Relativity.Logging.Interfaces" ], "headings": [ "Logging Interfaces .NET API Reference", "Relativity.Logging.Interfaces" ], "name": "Logging Interfaces .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.Logging.Interfaces namespace.", "title": "Logging Interfaces .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Logging_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Logging_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.Logging namespace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Logging .NET API Reference", "Relativity.Logging" ], "headings": [ "Logging .NET API Reference", "Relativity.Logging" ], "name": "Logging .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.Logging namespace.", "title": "Logging .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/LoggingInterfacesNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/LoggingInterfacesNETAPI.html" }, "description": "Logging Interfaces .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Logging Interfaces .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Logging Interfaces .NET API Reference", "title": "Logging Interfaces .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/LoggingNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/LoggingNETAPI.html" }, "description": "Logging .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Logging .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Logging .NET API Reference", "title": "Logging .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/RSAPI_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/RSAPI_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.Rsapi SDK. RSAPI is deprecated, but you may still need the SDKs in the RSAPI Package.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "RSAPI SDK .NET API Reference", "Relativity.Rsapi" ], "headings": [ "RSAPI SDK .NET API Reference", "Relativity.Rsapi" ], "name": "RSAPI SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.Rsapi SDK. RSAPI is deprecated, but you may still need the SDKs in the RSAPI Package.", "title": "RSAPI SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/RSAPINETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/RSAPINETAPI.html" }, "description": "RSAPI SDK .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "RSAPI SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "RSAPI SDK .NET API Reference", "title": "RSAPI SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Search_Container_Manager_API.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/RSAPI/Relativity_services/Search_Container_Manager_API.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Search Container Manager (.NET)", "Create a SearchContainer", "Read a SearchContainer", "Update a SearchContainer", "Delete a SearchContainer", "Query SearchContainers", "List SearchContainer content", "GetSearchContainerItemsAsync()", "GetChildSearchContainersAsync()", "Retrieve expanded search container nodes", "GetSearchContainerTreeAsync()", "GetFilteredSearchContainerTreeAsync()", "Retrieve Advanced Search View fields", "GetAdvancedSearchViewInfoAsync()", "GetAdvancedSearchViewUniqueCreatedByAsync", "GetAdvancedSearchViewUniqueModifiedByAsync()", "GetAdvancedSearchViewUniqueOwnersAsync()", "Move SearchContainer" ], "headings": [ "Search Container Manager (.NET)", "Create a SearchContainer", "Read a SearchContainer", "Update a SearchContainer", "Delete a SearchContainer", "Query SearchContainers", "List SearchContainer content", "GetSearchContainerItemsAsync()", "GetChildSearchContainersAsync()", "Retrieve expanded search container nodes", "GetSearchContainerTreeAsync()", "GetFilteredSearchContainerTreeAsync()", "Retrieve Advanced Search View fields", "GetAdvancedSearchViewInfoAsync()", "GetAdvancedSearchViewUniqueCreatedByAsync", "GetAdvancedSearchViewUniqueModifiedByAsync()", "GetAdvancedSearchViewUniqueOwnersAsync()", "Move SearchContainer" ], "name": "Search Container Manager (.NET)", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Search Container Manager (.NET)" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Best_practices_for_Relativity_scripts.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Best_practices_for_Relativity_scripts.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Best practices for Relativity scripts", "Verify your security permissions", "Avoid errors and performance issues", "Upgrade scripts for database schema changes", "Contact Support when necessary" ], "headings": [ "Best practices for Relativity scripts", "Verify your security permissions", "Avoid errors and performance issues", "Upgrade scripts for database schema changes", "Contact Support when necessary" ], "name": "Best practices for Relativity scripts", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Best practices for Relativity scripts" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Creating_a_new_script.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Creating_a_new_script.htm" }, "description": "If you are a system admin, you can create and edit scripts in Relativity. Before creating a script, it\u0027s important to read the script formatting section. Due to the complexity and impact a script can have, only expert users of Relativity and SQL should create scripts.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Create a new Relativity Script", "Relativity Script Library", "Workspace scripts" ], "headings": [ "Create a new Relativity Script", "Relativity Script Library", "Workspace scripts" ], "name": "Create a new Relativity Script", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "If you are a system admin, you can create and edit scripts in Relativity. Before creating a script, it\u0027s important to read the script formatting section. Due to the complexity and impact a script can have, only expert users of Relativity and SQL should create scripts.", "title": "Create a new Relativity Script" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Developing_Relativity_scripts.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Developing_Relativity_scripts.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Relativity Scripts", "headings": "Relativity Scripts", "name": "Relativity Scripts", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity Scripts" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Global_script_variables.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Global_script_variables.htm" }, "description": "The following global script variables go into the content of the action and are replaced with a preset value.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Global script variables", "headings": "Global script variables", "name": "Global script variables", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The following global script variables go into the content of the action and are replaced with a preset value.", "title": "Global script variables" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/acl.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/acl.htm" }, "description": "This tag pulls back a list of ACL\u0026#160;ID\u0027s for the current user based on the attributes values so they can be referenced inside of a script.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "acl", "Hierarchy", "Syntax", "Attributes", "Example" ], "headings": [ "acl", "Hierarchy", "Syntax", "Attributes", "Example" ], "name": "acl", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This tag pulls back a list of ACL\u0026#160;ID\u0027s for the current user based on the attributes values so they can be referenced inside of a script.", "title": "acl" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/action.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/action.htm" }, "description": "You can use this tag multiple times to pull back more than one data table from SQL.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "action", "Hierarchy", "Syntax", "Attributes", "Reference inputs", "Example" ], "headings": [ "action", "Hierarchy", "Syntax", "Attributes", "Reference inputs", "Example" ], "name": "action", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "You can use this tag multiple times to pull back more than one data table from SQL.", "title": "action" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/category.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/category.htm" }, "description": "Categories are text fields on the Relativity script object that can help you define the script type. You can also create your own categories.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "category", "Hierarchy", "Syntax", "Default categories", "Example" ], "headings": [ "category", "Hierarchy", "Syntax", "Default categories", "Example" ], "name": "category", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Categories are text fields on the Relativity script object that can help you define the script type. You can also create your own categories.", "title": "category" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/constant.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/constant.htm" }, "description": "Constants are values (either static or user input) that get passed into the SQL\u0026#160;action section. Each constant in the input is entered using XML and contains three main parts.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "constant", "Hierarchy", "Syntax", "Attributes", "Children", "Example" ], "headings": [ "constant", "Hierarchy", "Syntax", "Attributes", "Children", "Example" ], "name": "constant", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Constants are values (either static or user input) that get passed into the SQL\u0026#160;action section. Each constant in the input is entered using XML and contains three main parts.", "title": "constant" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/description.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/description.htm" }, "description": "The value between these tags is used to populate the description column of the script.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "description", "Hierarchy", "Syntax", "Example" ], "headings": [ "description", "Hierarchy", "Syntax", "Example" ], "name": "description", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The value between these tags is used to populate the description column of the script.", "title": "description" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/display.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/display.htm" }, "description": "The display element allows you to control how the script output will be rendered when the script is run.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "display", "Hierarchy", "Syntax", "Attributes", "Children", "Example" ], "headings": [ "display", "Hierarchy", "Syntax", "Attributes", "Children", "Example" ], "name": "display", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The display element allows you to control how the script output will be rendered when the script is run.", "title": "display" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/field.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/field.htm" }, "description": "This tag allows you to reference Relativity case fields.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "field", "Hierarchy", "Syntax", "Attributes", "Children", "Remarks", "Example" ], "headings": [ "field", "Hierarchy", "Syntax", "Attributes", "Children", "Remarks", "Example" ], "name": "field", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This tag allows you to reference Relativity case fields.", "title": "field" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/filters.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/filters.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "filters", "Hierarchy", "Syntax", "Children", "Example" ], "headings": [ "filters", "Hierarchy", "Syntax", "Children", "Example" ], "name": "filters", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "filters" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/filters_category.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/filters_category.htm" }, "description": "This element allows you to narrow the field type to a sub-set based on a specific attribute.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "category", "Hierarchy", "Syntax", "Category values", "Example" ], "headings": [ "category", "Hierarchy", "Syntax", "Category values", "Example" ], "name": "category", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This element allows you to narrow the field type to a sub-set based on a specific attribute.", "title": "category" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/input.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/input.htm" }, "description": "This tag allows you to define the orientation of your report as well as define various attributes about your report.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "input", "Hierarchy", "Syntax", "Attributes", "Children" ], "headings": [ "input", "Hierarchy", "Syntax", "Attributes", "Children" ], "name": "input", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This tag allows you to define the orientation of your report as well as define various attributes about your report.", "title": "input" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/key.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/key.htm" }, "description": "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\u0027t modify it in any way regardless of your permissions. Once a script has been locked, it\u0027s no longer possible to edit it. On upgrade to a new version of Relativity, the installer may attempt to deploy new scripts in your Relativity environment. Any new scripts with a higher version and the same key as those in your current instance may be overwritten.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "key", "Hierarchy", "Syntax", "Example", "Edit a locked script" ], "headings": [ "key", "Hierarchy", "Syntax", "Example", "Edit a locked script" ], "name": "key", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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\u0027t modify it in any way regardless of your permissions. Once a script has been locked, it\u0027s no longer possible to edit it. On upgrade to a new version of Relativity, the installer may attempt to deploy new scripts in your Relativity environment. Any new scripts with a higher version and the same key as those in your current instance may be overwritten.", "title": "key" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/name.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/name.htm" }, "description": "The value between these tags is used to name (and populate the Name column of) the script.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "name", "Hierarchy", "Syntax", "Example" ], "headings": [ "name", "Hierarchy", "Syntax", "Example" ], "name": "name", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The value between these tags is used to name (and populate the Name column of) the script.", "title": "name" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/object.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/object.htm" }, "description": "This tag, if used, populates the specified display type with the current instances of the specified object type.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "object", "Hierarchy", "Syntax", "Attributes", "Example" ], "headings": [ "object", "Hierarchy", "Syntax", "Attributes", "Example" ], "name": "object", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This tag, if used, populates the specified display type with the current instances of the specified object type.", "title": "object" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/script.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/script.htm" }, "description": "The top XML element in the Relativity script body.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "script", "Hierarchy", "Syntax", "Child elements", "Example" ], "headings": [ "script", "Hierarchy", "Syntax", "Child elements", "Example" ], "name": "script", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The top XML element in the Relativity script body.", "title": "script" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/Script_properties.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/Script_properties.htm" }, "description": "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\u0027t give a value to the property, it\u0027s blank.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Script properties", "headings": "Script properties", "name": "Script properties", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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\u0027t give a value to the property, it\u0027s blank.", "title": "Script properties" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/search.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/search.htm" }, "description": "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\u0026#160;clause of its respective saved search.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "search", "Hierarchy", "Syntax", "Attributes", "Input", "Example" ], "headings": [ "search", "Hierarchy", "Syntax", "Attributes", "Input", "Example" ], "name": "search", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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\u0026#160;clause of its respective saved search.", "title": "search" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/searchprovider.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/searchprovider.htm" }, "description": "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\u0027s ID.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "searchprovider", "Hierarchy", "Syntax", "Attributes", "Input", "Example" ], "headings": [ "searchprovider", "Hierarchy", "Syntax", "Attributes", "Input", "Example" ], "name": "searchprovider", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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\u0027s ID.", "title": "searchprovider" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/security.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/security.htm" }, "description": "This element enables you to reference the current user ACL lists in your scripts.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "security", "Hierarchy", "Syntax", "Child elements", "Example" ], "headings": [ "security", "Hierarchy", "Syntax", "Child elements", "Example" ], "name": "security", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This element enables you to reference the current user ACL lists in your scripts.", "title": "security" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/settings.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/settings.htm" }, "description": "This tag defines certain attributes about your report. Currently you can define the report title.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "settings", "Hierarchy", "Syntax", "Attributes", "Example" ], "headings": [ "settings", "Hierarchy", "Syntax", "Attributes", "Example" ], "name": "settings", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This tag defines certain attributes about your report. Currently you can define the report title.", "title": "settings" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/sql.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/sql.htm" }, "description": "This tag, if used, populates a drop-down menu with the return value of an inline SQL\u0026#160;statement.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "sql", "Hierarchy", "Syntax", "Attributes", "Input", "Example" ], "headings": [ "sql", "Hierarchy", "Syntax", "Attributes", "Input", "Example" ], "name": "sql", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This tag, if used, populates a drop-down menu with the return value of an inline SQL\u0026#160;statement.", "title": "sql" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/type.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/type.htm" }, "description": "This tag defines which Relativity field types appear in the filters drop-down menu.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "type", "Hierarchy", "Syntax", "Type values" ], "headings": [ "type", "Hierarchy", "Syntax", "Type values" ], "name": "type", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This tag defines which Relativity field types appear in the filters drop-down menu.", "title": "type" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/version.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Script_properties/version.htm" }, "description": "The value between these tags is used to track the internal script version.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "version", "Hierarchy", "Syntax", "Example" ], "headings": [ "version", "Hierarchy", "Syntax", "Example" ], "name": "version", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "The value between these tags is used to track the internal script version.", "title": "version" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Using_scripts_in_Relativity.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Scripts/Using_scripts_in_Relativity.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Use scripts in Relativity", "headings": "Use scripts in Relativity", "name": "Use scripts in Relativity", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Use scripts in Relativity" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Search.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Search.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Search", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Search" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Site_Resources/Custom_Applications_Support.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Site_Resources/Custom_Applications_Support.htm" }, "description": "How to debug a custom Relativity application, and what information to provide to Relativity support for help", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Debugging custom applications and support for custom applications", "Troubleshooting for all extensibility points", "Unit Tests", "Logging", "Templates", "Troubleshooting specific extensibility points", "Contacting Relativity" ], "headings": [ "Debugging custom applications and support for custom applications", "Troubleshooting for all extensibility points", "Unit Tests", "Logging", "Templates", "Troubleshooting specific extensibility points", "Contacting Relativity" ], "name": "Debugging custom applications and support for custom applications", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "How to debug a custom Relativity application, and what information to provide to Relativity support for help", "title": "Debugging custom applications and support for custom applications" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Site_Resources/Get_started_with_DevHelp.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Site_Resources/Get_started_with_DevHelp.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Get started with the Relativity DevHelp Community", "Relativity Community user account", "Using the Relativity DevHelp Community", "Logging into Relativity DevHelp Community", "Posting a Topic", "Replying to a Topic", "Editing a Topic", "Community guidelines" ], "headings": [ "Get started with the Relativity DevHelp Community", "Relativity Community user account", "Using the Relativity DevHelp Community", "Logging into Relativity DevHelp Community", "Posting a Topic", "Replying to a Topic", "Editing a Topic", "Community guidelines" ], "name": "Get started with the Relativity DevHelp Community", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Get started with the Relativity DevHelp Community" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Sitemap.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Sitemap.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": "Sitemap", "headings": "Sitemap", "name": "Sitemap", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Sitemap" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Relativity_Transfer_SDK.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Relativity_Transfer_SDK.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Transfer SDK", "Version History", "Fundamentals for the Relativity Transfer SDK", "Staging Governance compliance", "Example of implementing the Relativity Transfer SDK", "Code samples", "Create instance of SDK client", "Transfer progress", "Transfer options", "Upload a directory", "Upload a file", "Upload a list of items", "Download a file", "Download a directory", "Job based workflow" ], "headings": [ "Relativity Transfer SDK", "Version History", "Fundamentals for the Relativity Transfer SDK", "Staging Governance compliance", "Example of implementing the Relativity Transfer SDK", "Code samples", "Create instance of SDK client", "Transfer progress", "Transfer options", "Upload a directory", "Upload a file", "Upload a list of items", "Download a file", "Download a directory", "Job based workflow" ], "name": "Relativity Transfer SDK", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity Transfer SDK" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Relativity_Transfer_Service.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Relativity_Transfer_Service.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Transfer Service", "Authentication", "How to start Azure to R1 transfer", "Source requirements", "Workflow", "Job stages", "How to get QC report", "QC report structure", "Error codes", "API endpoints", "POST v2/transfer/jobs", "GET v2/transfer/jobs/", "DELETE v2/transfer/jobs/{job_id}", "GET v2/transfer/jobs/{jobId}/qc" ], "headings": [ "Relativity Transfer Service", "Authentication", "How to start Azure to R1 transfer", "Source requirements", "Workflow", "Job stages", "How to get QC report", "QC report structure", "Error codes", "API endpoints", "POST v2/transfer/jobs", "GET v2/transfer/jobs/", "DELETE v2/transfer/jobs/{job_id}", "GET v2/transfer/jobs/{jobId}/qc" ], "name": "Relativity Transfer Service", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Relativity Transfer Service" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Relativity_Transfer_Service_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Relativity_Transfer_Service_NET_API_Reference.htm" }, "description": "Landing page for the Relativity Transfer Service .NET API reference.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity Transfer Service", "Relativity Transfer Service NET API Reference" ], "headings": [ "Relativity Transfer Service", "Relativity Transfer Service NET API Reference" ], "name": "Relativity Transfer Service NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Landing page for the Relativity Transfer Service .NET API reference.", "title": "Relativity Transfer Service NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Transfer_NET_API_Reference.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Transfer_NET_API_Reference.htm" }, "description": "Browse the .NET API reference for the Relativity.Transfer.SDK namespace.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Transfer SDK .NET API Reference", "Relativity.Transfer.SDK" ], "headings": [ "Transfer SDK .NET API Reference", "Relativity.Transfer.SDK" ], "name": "Transfer SDK .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Browse the .NET API reference for the Relativity.Transfer.SDK namespace.", "title": "Transfer SDK .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/TransferNETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/TransferNETAPI.html" }, "description": "Transfer .NET API Reference", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Transfer .NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Transfer .NET API Reference", "title": "Transfer .NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Transferv2NETAPI.html", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/Transfer_API/Transferv2NETAPI.html" }, "description": "Relativity Transfer Service v2", "type": "TechArticle", "dateModified": "2026-09-30", "tags": [ ], "headings": [ ], "name": "Relativity Transfer Service NET API Reference", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Relativity Transfer Service v2", "title": "Relativity Transfer Service NET API Reference" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/What_s_new/Classic_List_Page_API_deprecation.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/What_s_new/Classic_List_Page_API_deprecation.htm" }, "description": "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.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Classic List Page API deprecation", "Initializer API", "Event-based APIs", "General service APIs" ], "headings": [ "Classic List Page API deprecation", "Initializer API", "Event-based APIs", "General service APIs" ], "name": "Classic List Page API deprecation", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "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.", "title": "Classic List Page API deprecation" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/What_s_new/Database_schema_updates.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/What_s_new/Database_schema_updates.htm" }, "description": "Lists changes and additions made to the EDDS and Workspace database schema for Relativity.", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Database schema updates", "Database schema updates table" ], "headings": [ "Database schema updates", "Database schema updates table" ], "name": "Database schema updates", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Lists changes and additions made to the EDDS and Workspace database schema for Relativity.", "title": "Database schema updates" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/What_s_new/Platform_Changes.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/What_s_new/Platform_Changes.htm" }, "description": "Describes upcoming changes to the Relativity Platform", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Platform Architecture Changes", "Areas affected by the platform changes" ], "headings": [ "Platform Architecture Changes", "Areas affected by the platform changes" ], "name": "Platform Architecture Changes", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "Describes upcoming changes to the Relativity Platform", "title": "Platform Architecture Changes" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/What_s_new/Release_notes.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/What_s_new/Release_notes.htm" }, "description": "View and track product release notes, developer change log, and known issues", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity aiR release notes", "Release notes, developer change log, and known issues." ], "headings": [ "Relativity aiR release notes", "Release notes, developer change log, and known issues." ], "name": "Relativity aiR release notes", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "View and track product release notes, developer change log, and known issues", "title": "Relativity aiR release notes" }, { "url": "https://platform.relativity.com/RelativityaiR/Content/What_s_new/What_s_new.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/Content/What_s_new/What_s_new.htm" }, "description": "This page highlights selected new features in Relativity aiR of interest to developers", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ "Relativity aiR Developer News", "Coming soon", "Legacy SQL permissions will be retired", "Legacy Relativity.ObjectManager package deprecated", "Direct SQL access to the EDDSArchiving database will be removed", "Reminders", "Platform Architecture Changes", "Released Items", "Object Manager Rate Limiting", "Older versions of Transfer SDK deprecated", "Workspace Manager API endpoints deprecated", "Processing API endpoints deprecated", "v0 version of Processing API deprecated", "Legacy Document Viewer APIs deprecated", "Cold Storage API endpoints deprecated", "The V1 version of ARM API is deprecated", "Custom Triggers no longer permitted", "Direct access to Processing SQL DataStores removed", "New ProcessingFilterManager endpoint for DeNIST reporting", "New documentation resources for AI solutions", "Staging Reports v3 API deprecated", "ProcessingFilterManager and ProcessingDocumentManager V1 APIs deprecation", "OAuth2 Client Secrets shown once only", "Integration Points load file workflow deprecation", "Breaking change affecting List Page Interaction event handlers", "Return Processing Duplicate Hash", "Error tab deprecation", "Data Management: Cold Storage determined by the \"Workspace State\" field", "Collect Folder Path Data Solution deprecation", "Lucene Search deprecation", "Audit Metrics REST API endpoint\u0026#160;deprecation", "Breaking change in Relativity Audit API" ], "headings": [ "Relativity aiR Developer News", "Coming soon", "Legacy SQL permissions will be retired", "Legacy Relativity.ObjectManager package deprecated", "Direct SQL access to the EDDSArchiving database will be removed", "Reminders", "Platform Architecture Changes", "Released Items", "Object Manager Rate Limiting", "Older versions of Transfer SDK deprecated", "Workspace Manager API endpoints deprecated", "Processing API endpoints deprecated", "v0 version of Processing API deprecated", "Legacy Document Viewer APIs deprecated", "Cold Storage API endpoints deprecated", "The V1 version of ARM API is deprecated", "Custom Triggers no longer permitted", "Direct access to Processing SQL DataStores removed", "New ProcessingFilterManager endpoint for DeNIST reporting", "New documentation resources for AI solutions", "Staging Reports v3 API deprecated", "ProcessingFilterManager and ProcessingDocumentManager V1 APIs deprecation", "OAuth2 Client Secrets shown once only", "Integration Points load file workflow deprecation", "Breaking change affecting List Page Interaction event handlers", "Return Processing Duplicate Hash", "Error tab deprecation", "Data Management: Cold Storage determined by the \"Workspace State\" field", "Collect Folder Path Data Solution deprecation", "Lucene Search deprecation", "Audit Metrics REST API endpoint\u0026#160;deprecation", "Breaking change in Relativity Audit API" ], "name": "Developer News", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": "This page highlights selected new features in Relativity aiR of interest to developers", "title": "Developer News" }, { "url": "https://platform.relativity.com/RelativityaiR/index.htm", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://platform.relativity.com/RelativityaiR/index.htm" }, "description": "TODO", "type": "TechArticle", "dateModified": "2026-10-13", "tags": [ ], "headings": [ ], "name": "Untitled", "inLanguage": "en", "isPartOf": "https://platform.relativity.com/RelativityaiR", "about": { }, "title": "Untitled" } ], "license": "https://platform.relativity.com/RelativityaiR/legal/terms-of-use.html" }