Therefore Application Programming Interface

https://therefore.net/help/2024/en-us/AR/SDK/API/
Admin
The Therefore™ Application Programming Interface (API) provides comprehensive tools for developers...
Tokens:739,072
Snippets:4,720
Trust Score:9.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Therefore API - Basics

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide

Guides on connecting to the Therefore™ Server and handling exceptions.

```APIDOC
## Connect to the Therefore™ Server

### Description
This section covers the fundamental steps to establish a connection with the Therefore™ Server.

### Method
N/A (Conceptual Guide)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

## Handle Exceptions

### Description
This section details how to effectively manage and handle exceptions that may occur during API interactions.

### Method
N/A (Conceptual Guide)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### TheApplication NavigatorFind Method

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_theapplication_navigatorfind_1

Starts the Therefore Navigator and opens a query with specified values. Handles starting the Navigator if it's not already running.

```APIDOC
## POST /NavigatorFind

### Description
Starts Therefore™ Navigator if Navigator is not running; opens a query with the query values set with SetCtgryNo and SetField.

### Method
POST

### Endpoint
/NavigatorFind

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **pIndexData** (TheIndexData) - Required - TheIndexData containing at least a valid category number.
- **nFlags** (TheNavigatorFindFlags) - Required - Flags for the search process.
- **hwndNotify** (Integer) - Required - Reserved for future use.

### Request Example
```json
{
  "pIndexData": {
    "categoryNumber": 123,
    "fieldValues": [
      {
        "fieldId": "FIELD_NAME",
        "value": "Example Value"
      }
    ]
  },
  "nFlags": 4,
  "hwndNotify": 0
}
```

### Response
#### Success Response (200)
None (This method returns void/doesn't return a value).

#### Response Example
(No response body for success)

### Exceptions
- **NullReferenceArgument**: Thrown if pIndexData is null.
- **CategoryUndefined**: Thrown if pIndexData does not contain a valid category number.
```

--------------------------------

### Create AddIn Class in C#

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide_addins_creationeventlog

This guide explains how to create a new AddIn class using Microsoft Visual Studio and C# for the Therefore platform. It covers the initial setup and basic structure for developing custom AddIns.

```C#
// Example structure for a C# AddIn class
public class MyAddIn : IThereforeAddIn
{
    // AddIn initialization logic
    public void Initialize(IAddInHost host)
    {
        // ...
    }

    // AddIn execution logic
    public void Execute(IAddInContext context)
    {
        // ...
    }
}
```

--------------------------------

### Finding Workflow Instances (C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide

This example shows how to find workflow instances within the Therefore™ system. It utilizes the 'TheQuery' class to search for instances based on specific criteria.

```csharp
using Therefore;

public class WorkflowInstanceSearch
{
    public void FindWorkflowInstances()
    {
        TheServer server = new TheServer();
        TheQuery query = new TheQuery();

        // Define query for workflow instances
        // Example: Find instances of a specific process
        // query.AddCondition(new TheCondition("ProcessName", "ApprovalProcess"));

        // Or find all instances

        TheQueryResult results = query.Execute();
        Console.WriteLine($"Found {results.ResultRows.Count} workflow instances.");
        // Process the results
    }
}
```

--------------------------------

### Start Task Method (Visual Basic and C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thetask_methods_start

This method starts a task within the Therefore system. It requires a valid and connected TheServer object as input and returns the ID of the newly created task. Ensure the TheServer object is properly initialized before calling this method.

```visualbasic
Public Overridable Function Start( _
    pServer As TheServer _
) As Integer
```

```csharp
public virtual int Start(
    TheServer pServer
)
```

--------------------------------

### C# AddIn Event Log Example

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide_addins_eventlog

This C# code provides an example of creating an AddIn for the Therefore API that logs events. It registers for all events and writes the captured event log to a file upon application exit. Requires Therefore.API.

```csharp
using System;
using System.Collections.Generic;
using System.IO;
using System.Runtime.InteropServices;
using System.Text;
using Therefore.API;
namespace AddInSamples {
    [Guid("F72A6BF3-6A97-4236-96F3-A57C23110F31"), ComVisible(true), ClassInterface(ClassInterfaceType.None)]
    class EventLogAddIn : ITheAddIn {
        private string eventLog;
        public void GetHandledEvents(TheClientType client, TheEventSet eventSet) {
            // Register for all events
            eventSet.AddAll();
        }
        public int HandleEvent(TheEvent e) {
            // Append the current event to a string
            eventLog += DateTime.Now.ToString() + " ... " + e.ToString() + "\r\n";
            // Write the event log to a file when the application exits
            if (e.EventType == TheEventType.ExitApplication) {
                StreamWriter writer = new StreamWriter("eventLog.txt");
                writer.WriteLine(eventLog);
                writer.Flush();
            }
            return 0;
        }
    }
}
```

--------------------------------

### TheWFTransition.Description Property

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thewftransition_description

Gets the description of this transition.

```APIDOC
## TheWFTransition.Description Property

### Description
Gets the description of this transition.

### Method
GET

### Endpoint
/api/TheWFTransition/Description

### Parameters
#### Query Parameters
- **workflowId** (string) - Required - The ID of the workflow.

### Request Example
```json
{
  "workflowId": "string"
}
```

### Response
#### Success Response (200)
- **description** (string) - The description of the transition.

#### Response Example
```json
{
  "description": "This is a sample transition description."
}
```
```

--------------------------------

### Customizing Menu Items (C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide

This example shows how to customize the menu items within the Therefore™ interface using the 'TheMenu' class. It allows adding custom actions to the UI.

```csharp
using Therefore;

public class MenuCustomization
{
    public void AddCustomMenuItem(TheServer server)
    {
        TheMenu menu = server.GetMenu("MainDocumentMenu"); // Example menu
        // Add a new menu item
        // menu.AddItem("My Custom Action", HandleCustomAction);
        Console.WriteLine("Custom menu item added.");
    }

    // private void HandleCustomAction(object context)
    // {
    //     // Logic for the custom action
    //     Console.WriteLine("Custom action executed.");
    // }
}
```

--------------------------------

### Create AddIn Class in VB.NET

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide_addins_creationeventlog

This guide explains how to create a new AddIn class using Microsoft Visual Studio and Visual Basic .NET for the Therefore platform. It covers the initial setup and basic structure for developing custom AddIns.

```VB.NET
' Example structure for a VB.NET AddIn class
Public Class MyAddIn
    Implements IThereforeAddIn

    ' AddIn initialization logic
    Public Sub Initialize(host As IAddInHost) Implements IThereforeAddIn.Initialize
        ' ...
    End Sub

    ' AddIn execution logic
    Public Sub Execute(context As IAddInContext) Implements IThereforeAddIn.Execute
        ' ...
    End Sub
End Class
```

--------------------------------

### AddIn Creation and Configuration in C#

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide_addins_newaddincsharp

Detailed steps to create, implement, and register a Therefore API AddIn using C#.

```APIDOC
## AddIn Creation and Configuration in C#

### Description
This guide outlines the process of developing a Therefore API AddIn. It covers setting up a C# project in Visual Studio, referencing the Therefore API, implementing the `ITheAddIn` interface, generating and applying a GUID, building the AddIn DLL, registering it using RegAsm, and configuring it in the Windows Registry.

### Method
This documentation describes a development process, not a direct API call.

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Steps:
1.  **Create Project:** Start Microsoft Visual Studio and create a new class library project.
2.  **Add Reference:** Add a reference to `The.API.Interop` or `Therefore API 3.0 Type Library`.
3.  **Add Namespaces:** Include `using System.Runtime.InteropServices;` and `using Therefore.API;`.
4.  **Create GUID:** Generate a GUID using Tools -> Create GUID, select "4. Registry Format", and paste it above the AddIn class declaration with `[Guid("YOUR-GUID-HERE"), ComVisible(true)]`.
5.  **Implement ITheAddIn:** Implement the `ITheAddIn` interface, including `GetHandledEvents` and `HandleEvent` methods.
6.  **Implement Test AddIn:** Add a reference to `System.Windows.Forms` and implement a simple test, e.g., displaying a message box.
7.  **Build AddIn DLL:** Build the solution in Visual Studio.
8.  **Register Assembly:** Open a command prompt, navigate to the DLL's directory, and run `regasm YourAddIn.dll`.
9.  **Configure Registry:** Open `regedit` and create/update keys under `HKEY_LOCAL_MACHINE/Software/Wow6432Node/Therefore/AddIns` and/or `HKEY_CURRENT_USER/Software/Therefore/AddIns` for relevant categories (All, Capture, CategoryDialog, Navigator, Viewer).
```

--------------------------------

### ExecuteSimple Query in C#

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide_queries_simplequery

Provides a C# example for connecting to the Therefore™ server and performing a simple document query with the ExecuteSimple method. The query targets category 5, field 70, searching for values starting with '3' and sorting by field 70.

```C#
using Therefore.API;
//...
// 1. Connect to the Therefore™ server
TheServer server = new TheServer();
server.Connect(TheClientType.CustomApplication);

// 2. Call the ExecuteSimple of a temporary TheQuery instance
// Finds index data in category 5 where field 70 starts with a "3"
// and sorts the results by the value of field 70.
TheQueryResult result =  
new TheQuery().ExecuteSimple(5, 70, "3*", 70, server);

// Optional 3. Display a message box with the results.
System.Windows.Forms.MessageBox.Show(result.ToString());
```

--------------------------------

### Get Case Definition GUID (C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thecasedefinition_guid

Retrieves the globally unique identifier (GUID) for a case definition using C# in the Therefore API. This property is part of the TheCaseDefinition class and provides read-only access to the GUID.

```C#
public virtual string GUID { get; }
```

--------------------------------

### TheFolder.GUID Property

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thefolder_guid

Gets the GUID of the folder.

```APIDOC
## Get Folder GUID

### Description
Retrieves the globally unique identifier (GUID) of a folder within the Therefore system.

### Method
GET

### Endpoint
/api/folders/{folderId}/guid

### Parameters
#### Path Parameters
- **folderId** (string) - Required - The unique identifier of the folder.

### Response
#### Success Response (200)
- **guid** (string) - The GUID of the folder.

#### Response Example
```json
{
  "guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```
```

--------------------------------

### TheTask.Start Method

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thetask_methods_start

Initiates a new task within the Therefore system. This method requires a valid and connected TheServer object.

```APIDOC
## POST /api/tasks/start

### Description
Starts a new task in the Therefore system. Requires a valid and connected TheServer object.

### Method
POST

### Endpoint
/api/tasks/start

### Parameters
#### Request Body
- **pServer** (TheServer) - Required - A valid and connected TheServer object representing the server to initiate the task on.

### Request Example
```json
{
  "pServer": {
    "serverName": "your_server_name",
    "port": 12345,
    "credentials": {
      "username": "user",
      "password": "password"
    }
  }
}
```

### Response
#### Success Response (200)
- **taskId** (integer) - The ID of the newly created task.

#### Response Example
```json
{
  "taskId": 12345
}
```
```

--------------------------------

### Get Folder GUID (Visual Basic)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thefolder_guid

Retrieves the GUID (Globally Unique Identifier) of a folder using Visual Basic. This property is read-only and part of the TheFolder class.

```Visual Basic
Public Overridable ReadOnly Property GUID As String
```

--------------------------------

### TheWFInstanceInfo.InitiatorNo Property

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thewfinstanceinfo_initiatorno

Gets the user number of the user who started the workflow instance.

```APIDOC
## TheWFInstanceInfo.InitiatorNo Property

### Description
Gets the user number of the user who started the workflow instance.

### Method
GET

### Endpoint
/websites/therefore_net_help_2024_en-us_ar_sdk_api

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **InitiatorNo** (Integer) - The number of the user who started the workflow instance.

#### Response Example
```json
{
  "InitiatorNo": 12345
}
```
```

--------------------------------

### NavigatorFind Overloads

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_theapplication_navigatorfind

This section details the various overloads for the NavigatorFind method, which starts the Therefore Navigator and opens a query.

```APIDOC
## NavigatorFind Overloads

### Description

These methods are used to start the Therefore™ Navigator. If the Navigator is not running, it will be started. The method then opens a query with specific values set using `SetCtgryNo` and `SetField`.

### Method

POST

### Endpoint

`/TheApplication/NavigatorFind`

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

**Overload 1: `NavigatorFind(TheIndexData, TheNavigatorFindFlags, int)`**

- **TheIndexData** (object) - Required - Specifies the index data for the query.
- **TheNavigatorFindFlags** (object) - Required - Flags to control the behavior of the Navigator.
- **int** (integer) - Required - Reserved for future use or specific query parameters.

**Overload 2: `NavigatorFind(TheIndexData, TheNavigatorFindFlags, int, int)`**

- **TheIndexData** (object) - Required - Specifies the index data for the query.
- **TheNavigatorFindFlags** (object) - Required - Flags to control the behavior of the Navigator.
- **int (param3)** (integer) - Required - Reserved for future use or specific query parameters.
- **int (param4)** (integer) - Optional - Additional notify parameter reserved for future use.

**Overload 3: `NavigatorFind(TheServer, TheIndexData, TheNavigatorFindFlags, int)`**

- **TheServer** (object) - Required - Specifies the server to connect to.
- **TheIndexData** (object) - Required - Specifies the index data for the query.
- **TheNavigatorFindFlags** (object) - Required - Flags to control the behavior of the Navigator.
- **int** (integer) - Optional - Additional notify parameter reserved for future use.

**Overload 4: `NavigatorFind(TheIndexDataList, TheNavigatorFindFlags, int, int)`**

- **TheIndexDataList** (object) - Required - A list of index data values for a cross-category query.
- **TheNavigatorFindFlags** (object) - Required - Flags to control the behavior of the Navigator.
- **int (param3)** (integer) - Required - Reserved for future use or specific query parameters.
- **int (param4)** (integer) - Optional - Additional notify parameter reserved for future use.

### Request Example

```json
{
  "methodOverload": "NavigatorFind(TheIndexData, TheNavigatorFindFlags, int)",
  "parameters": {
    "TheIndexData": {
      "//": "Example TheIndexData object structure"
    },
    "TheNavigatorFindFlags": {
      "//": "Example TheNavigatorFindFlags object structure"
    },
    "int": 1
  }
}
```

### Response

#### Success Response (200)

- **status** (string) - Indicates the success of the operation (e.g., 'StartedNavigator', 'QueryOpened').
- **message** (string) - A descriptive message about the outcome.

#### Response Example

```json
{
  "status": "QueryOpened",
  "message": "Therefore Navigator started and query opened successfully."
}
```
```

--------------------------------

### TheWFTransition.TaskFromNo Property

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thewftransition_taskfromno

Gets the task number of the task from which this transition starts.

```APIDOC
## TheWFTransition.TaskFromNo Property

### Description
Gets the task number of the task from which this transition starts.

### Method
GET (Implicit - Property Access)

### Endpoint
Not Applicable (Property of a Class)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **TaskFromNo** (Integer) - The task number of the task from which this transition starts.

#### Response Example
```json
{
  "TaskFromNo": 12345
}
```
```

--------------------------------

### NavigatorFind Overloads (Visual Basic)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_theapplication_navigatorfind

Demonstrates the syntax for the NavigatorFind method overloads in Visual Basic. These methods start the Therefore Navigator and open queries with specified index data and flags.

```vbnet
NavigatorFind(TheIndexData As TheIndexData, TheNavigatorFindFlags As TheNavigatorFindFlags, notify As Integer)
NavigatorFind(TheIndexData As TheIndexData, TheNavigatorFindFlags As TheNavigatorFindFlags, notify As Integer, notify As Integer)
NavigatorFind(TheServer As TheServer, TheIndexData As TheIndexData, TheNavigatorFindFlags As TheNavigatorFindFlags, notify As Integer)
NavigatorFind(TheIndexDataList As TheIndexDataList, TheNavigatorFindFlags As TheNavigatorFindFlags, notify As Integer, notify As Integer)
```

--------------------------------

### TheWFInstance.InitiatorNo Property

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thewfinstance_initiatorno

Gets the user number of the user who started the workflow instance.

```APIDOC
## TheWFInstance.InitiatorNo Property

### Description
Gets the user number of the user who started the workflow instance.

### Method
GET

### Endpoint
/TheWFInstance/InitiatorNo

### Parameters
#### Query Parameters
- **None**

#### Request Body
- **None**

### Response
#### Success Response (200)
- **InitiatorNo** (Integer) - The number of the user who started the workflow instance.

#### Response Example
```json
{
  "InitiatorNo": 12345
}
```
```

--------------------------------

### Therefore API - AddIns

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide

Documentation for creating and configuring AddIns, managing category dialogs, menu customizations, and handling various event types.

```APIDOC
## AddIn Creation and Configuration

### Description
Guides on how to create and configure custom AddIns for the Therefore™ API.

### Method
N/A (Conceptual Guide)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

## Category Dialog Events

### Description
Handle events related to category dialogs within the Therefore™ system.

### Method
N/A (Conceptual Guide)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

## Menu Customization

### Description
Instructions for customizing menus in the Therefore™ interface.

### Method
N/A (Conceptual Guide)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

## RightsServer Document Events

### Description
Manage document-related events originating from the RightsServer.

### Method
N/A (Conceptual Guide)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

## Query Events

### Description
Handle events triggered during query operations.

### Method
N/A (Conceptual Guide)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Get Case Definition GUID (Visual Basic)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thecasedefinition_guid

Retrieves the globally unique identifier (GUID) for a case definition using Visual Basic in the Therefore API. This property is part of the TheCaseDefinition class.

```Visual Basic
Public Overridable Property GUID As String
```

--------------------------------

### NavigatorFind Method

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_theapplication_navigatorfind_2

Starts Therefore Navigator and opens a query with specified values.

```APIDOC
## NavigatorFind Method

### Description
Starts Therefore™ Navigator if it is not running and opens a query with the specified query values. The `notify` parameter is reserved for future use.

### Method
`NavigatorFind`

### Namespace
`Therefore.API`

### Syntax
**Visual Basic:**
`Public Overridable Function NavigatorFind (pIndexData As TheIndexData, nFlags As TheNavigatorFindFlags, nQueryNo As Integer, hwndNotify As Integer) As Void`

**C#:**
`public virtual void NavigatorFind (TheIndexData pIndexData, TheNavigatorFindFlags nFlags, int nQueryNo, int hwndNotify)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **pIndexData** (TheIndexData) - Required - TheIndexData containing at least a valid category number.
- **nFlags** (TheNavigatorFindFlags) - Required - Flags for the search process.
- **nQueryNo** (Integer) - Required - The number of the query to be opened. This allows opening predefined queries (e.g., FileBy, GroupBy) or category-predominant queries. If QueryNo is 0, Navigator opens the default query for the category.
- **hwndNotify** (Integer) - Optional - Reserved for future use.

### Request Example
```json
{
  "pIndexData": {
    "CategoryNumber": 123
  },
  "nFlags": 1,
  "nQueryNo": 456
}
```

### Response
#### Success Response (200)
This method does not return a value.

#### Response Example
(No response body for this method)

### Exceptions
- **Invalid Argument**: Occurs if `pIndexData` is null or does not contain a valid category number, AND `nQueryNo` is 0.

### Remarks
While it's possible to retrieve and display a document by using this function with a query that yields a single row and setting `nFlags` to 4, it is not recommended. For better performance when only one result is expected, use the `TheServer` function `DBQueryDoc` to get the document number and then call `Retrieve` and `View`. Use `NavigatorFind` primarily for activating Therefore™ Navigator to display result sets.
```

--------------------------------

### TheRecycleBinQuery.DeletedOnFrom Property

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_therecyclebinquery_deletedonfrom

Gets or sets the date specifying the start condition for the deletion date.

```APIDOC
## TheRecycleBinQuery.DeletedOnFrom Property

### Description
Gets or sets the date specifying the start condition for the deletion date.

### Method
Not Applicable (Property)

### Endpoint
Not Applicable (Property)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **DeletedOnFrom** (DateTime) - The date specifying the start condition for the deletion date.

#### Response Example
```json
{
  "DeletedOnFrom": "2024-01-01T00:00:00Z"
}
```
```

--------------------------------

### TheRoleAssignments Methods

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_theroleassignments_methods

Provides documentation for each method within the TheRoleAssignments class.

```APIDOC
## Add TheRoleAssignments

### Description
Adds a role assignment.

### Method
POST

### Endpoint
/api/v1/TheRoleAssignments/Add

### Parameters
#### Request Body
- **userId** (string) - Required - The ID of the user to assign a role to.
- **roleName** (string) - Required - The name of the role to assign.

### Request Example
```json
{
  "userId": "user123",
  "roleName": "Administrator"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the role assignment was successful.

#### Response Example
```json
{
  "success": true
}
```
```

```APIDOC
## DisableInheritance TheRoleAssignments

### Description
Disables the inheritance on the current object.

### Method
POST

### Endpoint
/api/v1/TheRoleAssignments/DisableInheritance

### Parameters
(No specific parameters mentioned, likely operates on the current context.)

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if inheritance was disabled successfully.

#### Response Example
```json
{
  "success": true
}
```
```

```APIDOC
## EnableInheritance TheRoleAssignments

### Description
Enables the inheritance on the current object and updates the role assignments.

### Method
POST

### Endpoint
/api/v1/TheRoleAssignments/EnableInheritance

### Parameters
(No specific parameters mentioned, likely operates on the current context.)

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if inheritance was enabled successfully.

#### Response Example
```json
{
  "success": true
}
```
```

```APIDOC
## Exists TheRoleAssignments

### Description
Checks if the role assignment for the specified user with the specified role exists in the current object.

### Method
GET

### Endpoint
/api/v1/TheRoleAssignments/Exists

### Parameters
#### Query Parameters
- **userId** (string) - Required - The ID of the user.
- **roleName** (string) - Required - The name of the role.

### Response
#### Success Response (200)
- **exists** (boolean) - True if the role assignment exists, false otherwise.

#### Response Example
```json
{
  "exists": true
}
```
```

```APIDOC
## Get TheRoleAssignments

### Description
Gets the role assignment for the specified user with the specified role.

### Method
GET

### Endpoint
/api/v1/TheRoleAssignments/Get

### Parameters
#### Query Parameters
- **userId** (string) - Required - The ID of the user.
- **roleName** (string) - Required - The name of the role.

### Response
#### Success Response (200)
- **roleAssignment** (object) - Details of the role assignment.
  - **userId** (string) - The user ID.
  - **roleName** (string) - The role name.
  - **assignedDate** (string) - The date the role was assigned.

#### Response Example
```json
{
  "roleAssignment": {
    "userId": "user123",
    "roleName": "Administrator",
    "assignedDate": "2024-01-01T10:00:00Z"
  }
}
```
```

```APIDOC
## GetEnumerator TheRoleAssignments

### Description
Returns an enumerator for this list.

### Method
GET

### Endpoint
/api/v1/TheRoleAssignments/GetEnumerator

### Parameters
(No parameters)

### Response
#### Success Response (200)
- **enumerator** (object) - An enumerator for the role assignments.

#### Response Example
```json
{
  "enumerator": {
    "current": null,
    "hasCurrent": false
  }
}
```
```

```APIDOC
## Load TheRoleAssignments

### Description
Loads the role assignments for the specified Therefore™ object from the TheServer.

### Method
GET

### Endpoint
/api/v1/TheRoleAssignments/Load

### Parameters
#### Query Parameters
- **objectId** (string) - Required - The ID of the Therefore™ object.

### Response
#### Success Response (200)
- **roleAssignments** (array) - A list of role assignments for the object.

#### Response Example
```json
{
  "roleAssignments": [
    {
      "userId": "user123",
      "roleName": "Viewer"
    }
  ]
}
```
```

```APIDOC
## Remove TheRoleAssignments

### Description
Removes the item with the specified index from the list.

### Method
DELETE

### Endpoint
/api/v1/TheRoleAssignments/RemoveByIndex

### Parameters
#### Query Parameters
- **index** (integer) - Required - The index of the role assignment to remove.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the removal was successful.

#### Response Example
```json
{
  "success": true
}
```
```

```APIDOC
## SaveChanges TheRoleAssignments

### Description
Saves all changes to the Therefore™ server.

### Method
POST

### Endpoint
/api/v1/TheRoleAssignments/SaveChanges

### Parameters
(No parameters, operates on pending changes.)

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if changes were saved successfully.

#### Response Example
```json
{
  "success": true
}
```
```

```APIDOC
## ShowDialog TheRoleAssignments

### Description
Displays the role assignment dialog for the current object.

### Method
GET

### Endpoint
/api/v1/TheRoleAssignments/ShowDialog

### Parameters
(No parameters, likely opens a UI dialog.)

### Response
#### Success Response (200)
- **dialogOpened** (boolean) - Indicates if the dialog was opened.

#### Response Example
```json
{
  "dialogOpened": true
}
```
```

```APIDOC
## ToString TheRoleAssignments

### Description
Returns a string representation of the object (for debugging).

### Method
GET

### Endpoint
/api/v1/TheRoleAssignments/ToString

### Parameters
(No parameters)

### Response
#### Success Response (200)
- **representation** (string) - A string representation of the object.

#### Response Example
```json
{
  "representation": "TheRoleAssignments Object"
}
```
```

--------------------------------

### TheWFInstanceInfo.ProcessDueDate Property

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thewfinstanceinfo_processstartdate

Gets the date when the current workflow instance was started. This property belongs to the TheWFInstanceInfo class within the Therefore.API namespace.

```APIDOC
## TheWFInstanceInfo.ProcessDueDate Property

### Description
Gets the date when the current workflow instance was started.

### Method
GET

### Endpoint
/websites/therefore_net_help_2024_en-us_ar_sdk_api/classes/TheWFInstanceInfo/properties/ProcessDueDate

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET /websites/therefore_net_help_2024_en-us_ar_sdk_api/classes/TheWFInstanceInfo/properties/ProcessDueDate
```

### Response
#### Success Response (200)
- **ProcessDueDate** (DateTime) - The date when the current workflow instance was started.

#### Response Example
```json
{
  "ProcessDueDate": "2024-01-01T00:00:00Z"
}
```
```

--------------------------------

### ITheRightsServer64 Interface Overview

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_itherightsserver64

Provides an overview of the ITheRightsServer64 interface, its purpose in customizing rights, and common implementation strategies.

```APIDOC
## Therefore Rights Server Interface (ITheRightsServer64)

### Description
The Therefore™ Rights Server interface (ITheRightsServer64) is a COM interface designed to allow developers to override default Therefore™ rights with custom logic. It supports partial or full overriding of rights and extending default rights with document-level specifics.

### Common Strategies

*   **Strategy 1: Implement GetObjectRights**
    Uses Therefore™ Default Rights for most objects, except for specific documents like categories and case definitions.

*   **Strategy 2: Implement GetDocRights**
    Called by the Therefore™ Viewer when a document is displayed. This strategy is invoked only for documents with document-level permissions (Security column in TheDocument table set to 1 or 2). A common approach is to use a database trigger to set this value, enabling the Rights Server to handle rights for desired documents without explicit permission settings.

### Key Methods

*   **GetDocRights**: Defines user rights for a specific document.
*   **GetObjRights**: Defines user rights for a specific Therefore™ Object (e.g., Category, Query).
*   **HasPermission**: Defines user rights for a specific Permission on a Therefore™ Object.
```

--------------------------------

### AddIn Workflow Customization (C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide_addins_workflowcustomization

Example implementation in C# for the `ITheAddIn` interface, demonstrating how to handle the `OpenWorkflowInstance` event and customize the workflow form.

```APIDOC
## Custom Workflow Dialog (C#)

### Description
This class implements `ITheAddIn` to handle the `OpenWorkflowInstance` event. It checks if the workflow instance matches "My Custom Process" and "My Custom Task", then displays a custom workflow form (`CustomWorkflowForm`). Based on user interaction with the custom form, it either claims the instance and finishes the current task, or returns to the default form.

### Method
POST

### Endpoint
`/api/workflow/custom`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (Implicitly uses `TheEvent` object passed to `HandleEvent`)

### Request Example
(Not applicable for this event-driven AddIn)

### Response
#### Success Response (1)
Returns `1` if the instance was processed and the inbox should be refreshed.
Returns `2` if the user canceled the request.
Returns `0` to display the default workflow form.

#### Response Example
`1`
```

--------------------------------

### TheTask.StartDate Property

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thetask_properties_startdate

Gets or sets the start date of the task. This property belongs to the TheTask class within the Therefore API.

```APIDOC
## TheTask.StartDate Property

### Description
Gets or sets the start date of the task.

### Method
GET/SET (Property Access)

### Endpoint
N/A (Class Property)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
Visual Basic:
```vb
Dim startDate As DateTime = myTask.StartDate
myTask.StartDate = New DateTime(2024, 12, 31)
```
C#:
```csharp
DateTime startDate = myTask.StartDate;
myTask.StartDate = new DateTime(2024, 12, 31);
```

### Response
#### Success Response (200)
**StartDate** (DateTime) - The start date for the task.

#### Response Example
```json
{
  "StartDate": "2024-10-27T10:00:00Z"
}
```
```

--------------------------------

### See Also

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thefulltextquery

Provides links to related classes and documentation.

```APIDOC
## See Also

- **TheFullTextQueryResult class**
- **Devleopers Guide - Full Text Query**
```

--------------------------------

### TheWFInstance.InitiatorNo Property (C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thewfinstance_initiatorno

Gets the user number of the user who started the workflow instance. This is a virtual, read-only property within the TheWFInstance class.

```C#
public virtual int InitiatorNo { get; }
```

--------------------------------

### Connecting to the Therefore™ Server

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide_basics_connect

This section details the process of connecting to the Therefore™ Server using the API. It includes initializing the server instance, connecting with different authentication methods, and disconnecting.

```APIDOC
## Connect to the Therefore™ Server

### Description
Establishes a connection to the Therefore™ Server, which is necessary for all database operations. This process involves initializing a `TheServer` instance and connecting using either the current user's credentials or a specified username and password.

### Method
`TheServer.Connect()`

### Endpoint
Not Applicable (This is a client-side API interaction)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
**Visual Basic:**
```vb
Imports Therefore.API

' Declare and initialize a new TheServer instance
Dim server As New TheServer

' Connect with the current user account
server.Connect(TheClientType.CustomApplication)

' Or connect with a specified user account and password
' server.Connect(TheClientType.CustomApplication, _
' "Domain\\Test", "masterkey")
```

**C#:**
```csharp
using Therefore.API;

// Declare and initialize a new TheServer instance
TheServer server = new TheServer();

// Connect with the current user account
server.Connect(TheClientType.CustomApplication);

// Or connect with a specified user account and password
// server.Connect(TheClientType.CustomApplication,
// "Domain\\Test", "masterkey");
```

### Response
#### Success Response (200)
Connection is established. The `Connected` property of the `TheServer` instance will return `True`.

#### Response Example
No specific response body is returned for a successful connection; the state change is reflected in the `TheServer.Connected` property.

### Remarks
- Use the `TheServer.Connected` property to verify the connection status.
- The `Connect` method has overloads to specify node IP address, alias, and to show a login dialog.
- It is good practice to explicitly call `server.Disconnect()` when finished to release resources.
```

--------------------------------

### Querying in Multiple Categories (C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide

This example shows how to execute a query across multiple categories in Therefore™. It utilizes the 'TheMultiQuery' class for combined searches.

```csharp
using Therefore;

public class MultiCategoryQuery
{
    public void ExecuteMultiCategoryQuery(int[] categoryIds)
    {
        TheServer server = new TheServer();
        TheMultiQuery multiQuery = new TheMultiQuery();

        foreach (int catId in categoryIds)
        {
            TheCategory category = server.GetCategory(catId);
            multiQuery.AddQuery(new TheQuery(category));
        }

        // Add conditions to the multi-query if needed
        // multiQuery.AddCondition(new TheCondition("Priority", "High"));

        TheMultiQueryResult results = multiQuery.Execute();
        Console.WriteLine($"Found {results.ResultRows.Count} documents across multiple categories.");
    }
}
```

--------------------------------

### ClaimInstance Method Syntax (Visual Basic and C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thewfinstance_claiminstance

Provides the syntax for the ClaimInstance method in both Visual Basic and C#. This method claims a workflow instance and requires a valid TheServer object as a parameter.

```Visual Basic
Public Overridable Function ClaimInstance ( _
    pServer As TheServer _
) As String
```

```C#
public virtual string ClaimInstance (
    TheServer pServer
)
```

--------------------------------

### Querying in Multiple Categories (VB.NET)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide

This example shows how to execute a query across multiple categories in Therefore™. It utilizes the 'TheMultiQuery' class for combined searches.

```vbnet
Imports Therefore

Public Class MultiCategoryQuery
    Public Sub ExecuteMultiCategoryQuery(categoryIds As Integer())
        Dim server As TheServer = New TheServer()
        Dim multiQuery As TheMultiQuery = New TheMultiQuery()

        For Each catId As Integer In categoryIds
            Dim category As TheCategory = server.GetCategory(catId)
            multiQuery.AddQuery(New TheQuery(category))
        Next

        ' Add conditions to the multi-query if needed
        ' multiQuery.AddCondition(New TheCondition("Priority", "High"))

        Dim results As TheMultiQueryResult = multiQuery.Execute()
        Console.WriteLine($"Found {results.ResultRows.Count} documents across multiple categories.")
    End Sub
End Class
```

--------------------------------

### TheRoleAssignment Methods

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_theroleassignment_methods

Reference for TheRoleAssignment methods, including setting conditions and obtaining string representations.

```APIDOC
## TheRoleAssignment Methods

### Description
Methods for managing role assignments within the Therefore API.

### Methods

#### SetCondition

##### Description
Sets a condition for the current role assignment.

##### Method
POST (assumed, as it modifies state)

##### Endpoint
`/api/v3/roles/assignments/{assignmentId}/condition` (example endpoint structure)

##### Parameters

###### Request Body
- **condition** (string) - Required - The condition to set for the role assignment.

### Request Example
```json
{
  "condition": "RequiresApproval"
}
```

#### ToString

##### Description
Returns a string representation of the object, useful for debugging.

##### Method
GET

##### Endpoint
`/api/v3/roles/assignments/{assignmentId}/toString` (example endpoint structure)

#### Response Example
```json
{
  "representation": "RoleAssignment(Id=123, Role=Admin, User=UserA)"
}
```
```

--------------------------------

### Extracting Files from Documents (C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide

This example demonstrates how to extract files associated with a document in the Therefore™ system. It uses the 'TheDocument' class to access and retrieve the files.

```csharp
using Therefore;

public class FileExtraction
{
    public void ExtractDocumentFiles(int docId)
    {
        TheServer server = new TheServer();
        TheDocument doc = server.GetDocument(docId);

        foreach (TheFile fileInfo in doc.Files)
        {
            // Save the file to a local path
            // fileInfo.SaveAs(@"C:\path\to\save\" + fileInfo.Name);
            Console.WriteLine("Extracted file: " + fileInfo.Name);
        }
    }
}
```

--------------------------------

### Extracting Files from Documents (VB.NET)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide

This example demonstrates how to extract files associated with a document in the Therefore™ system. It uses the 'TheDocument' class to access and retrieve the files.

```vbnet
Imports Therefore

Public Class FileExtraction
    Public Sub ExtractDocumentFiles(docId As Integer)
        Dim server As TheServer = New TheServer()
        Dim doc As TheDocument = server.GetDocument(docId)

        For Each fileInfo As TheFile In doc.Files
            ' Save the file to a local path
            ' fileInfo.SaveAs("C:\path\to\save\" & fileInfo.Name)
            Console.WriteLine("Extracted file: " & fileInfo.Name)
        Next
    End Sub
End Class
```

--------------------------------

### NavigatorFind Overloads (C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_theapplication_navigatorfind

Illustrates the syntax for the NavigatorFind method overloads in C#. These methods are used to initiate the Therefore Navigator and open queries with specific index data and flags.

```csharp
NavigatorFind(TheIndexData TheIndexData, TheNavigatorFindFlags TheNavigatorFindFlags, int notify)
NavigatorFind(TheIndexData TheIndexData, TheNavigatorFindFlags TheNavigatorFindFlags, int notify, int notify)
NavigatorFind(TheServer TheServer, TheIndexData TheIndexData, TheNavigatorFindFlags TheNavigatorFindFlags, int notify)
NavigatorFind(TheIndexDataList TheIndexDataList, TheNavigatorFindFlags TheNavigatorFindFlags, int notify, int notify)
```

--------------------------------

### Customizing Menu Items (VB.NET)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide

This example shows how to customize the menu items within the Therefore™ interface using the 'TheMenu' class. It allows adding custom actions to the UI.

```vbnet
Imports Therefore

Public Class MenuCustomization
    Public Sub AddCustomMenuItem(server As TheServer)
        Dim menu As TheMenu = server.GetMenu("MainDocumentMenu") ' Example menu
        ' Add a new menu item
        ' menu.AddItem("My Custom Action", New ActionHandler(AddressOf HandleCustomAction))
        Console.WriteLine("Custom menu item added.")
    End Sub

    ' Private Sub HandleCustomAction(context As Object)
    '     ' Logic for the custom action
    '     Console.WriteLine("Custom action executed.")
    ' End Sub
End Class
```

--------------------------------

### ShowDialog Method Implementation (VB & C#)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_thewfinstance_showdialog

Demonstrates the syntax for the ShowDialog method in both Visual Basic and C#. This method loads a specific workflow instance token and displays it. It requires a connected TheServer object, an instance number, and a token number. It handles potential NullReferenceException and InvalidServer exceptions.

```Visual Basic
Public Overridable Function ShowDialog ( _
 pServer As TheServer,
 nInstanceNo As Integer,
 nTokenNo As Integer
)
```

```C#
public virtual void ShowDialog (
 TheServer pServer,
 int nInstanceNo,
 int nTokenNo
)
```

--------------------------------

### Therefore™ API Overview

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/index

This section provides an overview of the Therefore™ API and its documentation structure, including sections on What's New, Developers Guide, and API Reference.

```APIDOC
## Therefore™ API Documentation Structure

### Description
This API provides access to the Therefore™ system, enabling integration with other applications. The documentation is organized into key sections to guide developers.

### API Sections:

- **What's New**: Details changes and new functionalities sorted by release version.
- **Developers Guide**: Offers a general introduction with step-by-step guides and code samples in Visual Basic and C#.
- **API Reference**: Contains detailed descriptions of all classes, methods, properties, and enumerations within the Therefore™ API.
```

--------------------------------

### Finding Workflow Instances (VB.NET)

Source: https://therefore.net/help/2024/en-us/AR/SDK/API/the_api_guide

This example shows how to find workflow instances within the Therefore™ system. It utilizes the 'TheQuery' class to search for instances based on specific criteria.

```vbnet
Imports Therefore

Public Class WorkflowInstanceSearch
    Public Sub FindWorkflowInstances()
        Dim server As TheServer = New TheServer()
        Dim query As TheQuery = New TheQuery()

        ' Define query for workflow instances
        ' Example: Find instances of a specific process
        ' query.AddCondition(New TheCondition("ProcessName", "ApprovalProcess"))

        ' Or find all instances

        Dim results As TheQueryResult = query.Execute()
        Console.WriteLine($"Found {results.ResultRows.Count} workflow instances.")
        ' Process the results
    End Sub
End Class
```
Tokens:
Raw