Workspace Manager (REST)

private HttpClient GetHttpClient()
{
    HttpClient httpClient = new HttpClient();
 
    httpClient.BaseAddress = new Uri("https://localhost/");
    httpClient.DefaultRequestHeaders.Add("X-CSRF-Header", "-");
    httpClient.DefaultRequestHeaders.Add("Authorization", "Basic " +
        Convert.ToBase64String(Encoding.GetEncoding("ISO-8859-1").GetBytes("test@test.com:SomePassword")));
 
    return httpClient;
}
 
private string BASE_URL = "Relativity.REST/api/Relativity.Workspaces/workspace";
 
private async Task<List<int>> GetArtifactIDList(HttpClient httpClient, string url)
{
    HttpResponseMessage response = await httpClient.GetAsync(url);
    string resultString = await response.Content.ReadAsStringAsync();
 
    var artifactIDs = new List<int>();
     
    dynamic objects = JArray.Parse(resultString) as JArray;
    foreach (var obj in objects)
    {
        int artifactID = obj.ArtifactID;
        artifactIDs.Add(artifactID);
    }
 
    return artifactIDs;
}
 
private async Task<List<int>> QueryArtifactIDList(HttpClient httpClient, string url)
{
    var queryRequest = new
    {
        request = new
        {
            Fields = new[]
            {
                new { Name = "*" }
            },
            Condition = ""
        },
        start = 1,
        length = 1000
    };
 
    StringContent payload = new StringContent(JsonConvert.SerializeObject(queryRequest), Encoding.UTF8, "application/json");
    HttpResponseMessage response = await httpClient.PostAsync(url, payload);
    string resultString = await response.Content.ReadAsStringAsync();
 
    var artifactIDs = new List<int>();
 
    dynamic result = JObject.Parse(resultString) as JObject;
    foreach (var obj in result.Objects)
    {
        int artifactID = obj.ArtifactID;
        artifactIDs.Add(artifactID);
    }
 
    return artifactIDs;
}
 
public async Task<List<int>> GetEligibleStatuses(HttpClient httpClient)
{
    return await GetArtifactIDList(httpClient, $"{BASE_URL}/eligible-statuses");
}
 
public async Task<List<int>> GetEligibleResourcePools(HttpClient httpClient)
{
    return await GetArtifactIDList(httpClient, $"{BASE_URL}/eligible-resource-pools");
}
 
public async Task<List<int>> GetEligibleFileRepositories(HttpClient httpClient, int resourcePoolID)
{
    return await GetArtifactIDList(httpClient, $"{BASE_URL}/eligible-resource-pools/{resourcePoolID}/eligible-file-repositories");
}
 
public async Task<List<int>> GetEligibleCacheLocations(HttpClient httpClient, int resourcePoolID)
{
    return await GetArtifactIDList(httpClient, $"{BASE_URL}/eligible-resource-pools/{resourcePoolID}/eligible-cache-locations");
}
 
public async Task<List<int>> GetEligibleSqlServers(HttpClient httpClient, int resourcePoolID)
{
    return await GetArtifactIDList(httpClient, $"{BASE_URL}/eligible-resource-pools/{resourcePoolID}/eligible-sql-servers");
}
 
public async Task<List<int>> GetEligibleAzureCredentials(HttpClient httpClient, int resourcePoolID)
{
    return await GetArtifactIDList(httpClient, $"{BASE_URL}/eligible-resource-pools/{resourcePoolID}/eligible-azure-credentials");
}
 
public async Task<List<int>> GetEligibleAzureFileSystemCredentials(HttpClient httpClient, int resourcePoolID)
{
    return await GetArtifactIDList(httpClient, $"{BASE_URL}/eligible-resource-pools/{resourcePoolID}/eligible-azure-file-system-credentials");
}
 
public async Task<List<int>> QueryEligibleMatters(HttpClient httpClient)
{
    return await QueryArtifactIDList(httpClient, $"{BASE_URL}/query-eligible-matters");
}
 
public async Task<List<int>> QueryEligibleTemplates(HttpClient httpClient)
{
    return await QueryArtifactIDList(httpClient, $"{BASE_URL}/query-eligible-templates");
}
 
public async Task<int> GetDefaultSqlFullTextLanguage(HttpClient httpClient)
{
    HttpResponseMessage response = await httpClient.GetAsync($"{BASE_URL}/eligible-sql-full-text-languages");
    string resultString = await response.Content.ReadAsStringAsync();
    dynamic languages = JObject.Parse(resultString) as JObject;
    int defaultLanguageID = languages.DefaultLanguageLcid;
    return defaultLanguageID;
}
 
public async Task<string> GetDefaultDownloadHandlerUrl(HttpClient httpClient)
{
    HttpResponseMessage response = await httpClient.GetAsync($"{BASE_URL}/default-download-handler-url");
    string result = await response.Content.ReadAsStringAsync();
    return JsonConvert.DeserializeObject<string>(result);
}
 
public async Task<int> CreateWorkspace(string name)
{
    HttpClient httpClient = GetHttpClient();
 
    int statusID = (await GetEligibleStatuses(httpClient)).First();
    int matterID = (await QueryEligibleMatters(httpClient)).First();
    string defaultDownloadHandlerUrl = await GetDefaultDownloadHandlerUrl(httpClient);
    int resourcePoolID = (await GetEligibleResourcePools(httpClient)).First();
    int fileRepositoryID = (await GetEligibleFileRepositories(httpClient, resourcePoolID)).First();
    int cacheLocationID = (await GetEligibleCacheLocations(httpClient, resourcePoolID)).First();
    int sqlServerID = (await GetEligibleSqlServers(httpClient, resourcePoolID)).First();
    int sqlFullTextLanguage = await GetDefautlSqlFullTextLanguage(httpClient);
    int templateID = (await QueryEligibleTemplates(httpClient)).First();
 
    var payloadObject = new
    {
        workspaceRequest = new
        {
            Name = name,
            Status = new { ArtifactID = statusID },
            Matter = new { Secured = false, Value = new { ArtifactID = matterID } },
            DownloadHandlerUrl = defaultDownloadHandlerUrl,
            EnableDataGrid = false,
            ResourcePool = new { Secured = false, Value = new { ArtifactID = resourcePoolID } },
            DefaultFileRepository = new { Secured = false, Value = new { ArtifactID = fileRepositoryID } },
            DefaultCacheLocation = new { Secured = false, Value = new { ArtifactID = cacheLocationID } },
            SqlServer = new { Secured = false, Value = new { ArtifactID = sqlServerID } },
            SqlFullTextLanguage = sqlFullTextLanguage,
            Template = new { Secured = false, Value = new { ArtifactID = templateID } },
            Keywords = "sample keywords for workspace",
            Notes = "sample notes for workspace"
        }
    };
 
    StringContent payload = new StringContent(JsonConvert.SerializeObject(payloadObject), Encoding.UTF8, "application/json");
    HttpResponseMessage response = await httpClient.PostAsync($"{BASE_URL}/", payload);
    string resultString = await response.Content.ReadAsStringAsync();
 
    dynamic result = JObject.Parse(resultString) as JObject;
    int artifactID = result.ArtifactID;
    return artifactID;
}

To use this endpoint, the caller must have the following:

• Add permissions for the workspace set at the instance level. See Instance security on the RelativityOne Documentation site.
• View Admin Repository permissions set for Admin Operations at the instance level. Alternatively, the user must be a system admin.

The body of the request must contain a workspaceRequest object with the following fields:

• DownloadHandlerUrl - a string representing the default URL used to make downloaded files available to users. This field is optional. If not specified in the request, the default URL is automatically selected by the algorithm.
• EnableDataGrid - a Boolean value indicating whether the workspace can have fields that save to Data Grid. This field can't be set during create operation.
• Matter - represents a securable matter object. A matter is the case or legal action associated with the workspace. It contains the following fields:
  • Secured - a Boolean value indicating whether the current user has permissions to view the settings in the Value field. The user can't view the Value field when this value is true. For a create request, set this value to false.
  • Value - contains the following fields:
    • ArtifactID - an integer used as a unique identifier for the object.
    • Guids - an array of GUIDs used to identify the object.
• Name - the user-friendly name of the workspace.
• ResourcePool - represents a securable resource pool object associated with the workspace. See descriptions for the Secured and Value fields under Matter. This field is optional. If not specified in the request, the resource pool is automatically selected by the algorithm.
• DefaultFileRepository - represents a securable file repository server object associated with the workspace. See descriptions for the Secured and Value fields under Matter. This field is optional. If not specified in the request, the file repository server is automatically selected by the algorithm.
• DataGridFileRepository - represents a securable file repository server object used for Data Grid. See descriptions for the Secured and Value fields under Matter. This field is optional. If not specified in the request, the file repository server for Data Grid is automatically selected by the algorithm.
• DefaultCacheLocation - represents a securable cache location server object associated with the workspace. See descriptions for the Secured and Value fields under Matter. This field is optional. If not specified in the request, the cache location server is automatically selected by the algorithm.
• SqlServer - represents a securable SQL server object associated with the workspace. See descriptions for the Secured and Value fields under Matter. This field is optional. If not specified in the request, the SQL server is automatically selected by the algorithm.
• AzureCredentials - represents a securable Azure credentials object associated with the workspace.
• AzureFileSystemCredentials - represents a securable Azure file system credentials object associated with the workspace. See descriptions for the Secured and Value fields under Matter.
• SqlFullTextLanguage - an integer representing the ID of the language used for determining the word-break characters used in the full text index for the workspace.
• Status - an object representing the status of the workspace used in views to filter on workspaces. It contains the following fields:
  • ArtifactID - an integer used as a unique identifier for the object.
  • Guids - an array of GUIDs used to identify the object.
• Template - an object representing an existing workspace structure used to create the workspace. You can only set this field in a create request. See descriptions for the Secured and Value fields under Matter.
• Keywords - optional words or phrases used to describe the workspace.
• Notes - additional information about the workspace.

{
  "workspaceRequest": {
    "DownloadHandlerUrl": "Relativity.Distributed",
    "EnableDataGrid": false,
    "Matter": {
      "Secured": false,
      "Value": {
        "ArtifactID": 1016816
      }
    },
    "Name": "Sample workspace",
    "ResourcePool": {
      "Secured": false,
      "Value": {
        "ArtifactID": 1015040
      }
    },
    "DefaultFileRepository": {
      "Secured": false,
      "Value": {
        "ArtifactID": 1014887
      }
    },
    "DataGridFileRepository": {
      "Secured": false,
      "Value": {
        "ArtifactID": 1015998
      }
    },
    "DefaultCacheLocation": {
      "Secured": false,
      "Value": {
        "ArtifactID": 1015534
      }
    },
    "SqlServer": {
      "Secured": false,
      "Value": {
        "ArtifactID": 1015096
      }
    },
    "AzureCredentials": null,
    "AzureFileSystemCredentials": null,
    "SqlFullTextLanguage": 1033,
    "Status": {
      "ArtifactID": 675
    },
    "Template": {
        "Secured": false,
        "Value": {
            "ArtifactID": 1014823
        }
    },
    "Keywords": "Sample keywords for a workspace",
    "Notes": "Sample notes for a workspace"
  }
}

{
  "workspaceRequest": {
    "EnableDataGrid": false,
    "Matter": {
      "Secured": false,
      "Value": {
        "ArtifactID": 1016816
      }
    },
    "Name": "Sample workspace",
    "AzureCredentials": null,
    "AzureFileSystemCredentials": null,
    "SqlFullTextLanguage": 1033,
    "Status": {
      "ArtifactID": 675
    },
    "Template": {
        "Secured": false,
        "Value": {
            "ArtifactID": 1014823
        }
    },
    "Keywords": "Sample keywords for a workspace",
    "Notes": "Sample notes for a workspace"
  }
}

The response returns an object representing a new workspace. It contains the following fields:

• Client - a securable client object associated with the workspace. It contains the following fields:
  • Secured - a Boolean value indicating whether the current user has permissions to view the settings in the Value field. The user can't view the Value field when this value is true.
  • Value - contains the following fields:
    • ArtifactID - an integer used as a unique identifier for the object.
    • Guids - an array of GUIDs used to identify the object.
    • Name - the user-friendly name of the object.
• ClientNumber - a securable object representing the client's number. It contains the following fields:
  • Secured - a Boolean value indicating whether the current user has permissions to view the settings in the Value field. The user can't view the Value field when this value is true.
  • Value - a string represents the number for the client.
• DownloadHandlerUrl - a string representing the default URL used to make downloaded files available to users.
• EnableDataGrid - a Boolean value indicating whether the workspace can have fields that save to Data Grid. This field can't be set during create operation.
• Matter - represents a securable matter object. A matter is the case or legal action associated with the workspace. See descriptions for the Secured and Value fields under Client.
• MatterNumber - a string representing the number for the matter associated with the workspace.
  • Secured - a Boolean value indicating whether the current user has permissions to view the settings in the Value field. The user can't view the Value field when this value is true.
  • Value - a string represents the number for the matter.
• ProductionRestrictions - represents a securable saved search object used for production restrictions. See descriptions for the Secured and Value fields under Client.
• ResourcePool - represents a securable resource pool object associated with the workspace. See descriptions for the Secured and Value fields under Client.
• DefaultFileRepository - represents a securable file repository server object associated with the workspace. See descriptions for the Secured and Value fields under Client.
• DefaultCacheLocation - represents a securable cache location server object associated with the workspace. See descriptions for the Secured and Value fields under Client.
• SqlServer - represents a securable SQL server object associated with the workspace. See descriptions for the Secured and Value fields under Client.
• SqlFullTextLanguage - an object representing the full text language used by the SQL Server. It contains the following fields:
  • Name - the name of the full text language used by the SQL Server.
  • ID - an integer used as a unique identifier for the language.
• Status - represents a workspace status object associated with the workspace. It contains the following fields:
  • Name - the user-friendly name of the status.
  • ArtifactID - an integer used to identify the status.
  • Guids - an array of GUIDs used to identify the status.
• Keywords - optional words or phrases used to describe the workspace.
• Notes - additional information about the workspace.
• CreatedOn - the date and time when the workspace was created.
• CreatedBy - represents the user who created the workspace. It contains the following fields:
  • Name - the name of the user.
  • ArtifactID - an integer used to identify the user.
  • Guids - an array of GUIDs used to identify the user.
• LastModifiedBy - represents the user who recently updated the workspace. See the field descriptions for the CreatedBy field.
• LastModifiedOn - the date and time when the workspace was most recently modified.
• Name - the user-friendly name of the workspace.
• ArtifactID - an integer used as a unique identifier for the workspace.
• Guids - an array of GUIDs used to identify the workspace.

{
  "Client": {
    "Secured": false,
    "Value": {
      "Name": "Relativity",
      "ArtifactID": 1015644,
      "Guids": []
    }
  },
  "ClientNumber": {
    "Secured": false,
    "Value": "Relativity"
  },
  "DownloadHandlerUrl": "Relativity.Distributed",
  "EnableDataGrid": false,
  "Matter": {
    "Secured": false,
    "Value": {
      "Name": "Salt vs. Pepper",
      "ArtifactID": 1016816,
      "Guids": []
    }
  },
  "MatterNumber": {
    "Secured": false,
    "Value": "1"
  },
  "ProductionRestrictions": {
    "Secured": false,
    "Value": {
      "Name": "Saved Search 1",
      "ArtifactID": 1117132,
      "Guids": []
    }
  },
  "ResourcePool": {
    "Secured": false,
    "Value": {
      "Name": "Default",
      "ArtifactID": 1015040,
      "Guids": []
    }
  },
  "DefaultFileRepository": {
    "Secured": false,
    "Value": {
      "Name": "\\\\A-BC-DE-FGHIJK\\fileshare\\",
      "ArtifactID": 1014887,
      "Guids": []
    }
  },
  "DefaultCacheLocation": {
    "Secured": false,
    "Value": {
      "Name": "Default Cache Location",
      "ArtifactID": 1015534,
      "Guids": []
    }
  },
  "SqlServer": {
    "Secured": false,
    "Value": {
      "Name": "A-BC-DE-FGHIJK\\EDDSINSTANCE001",
      "ArtifactID": 1015096,
      "Guids": []
    }
  },
  "SqlFullTextLanguage": {
    "Name": "English",
    "ID": 1033
  },
  "Status": {
    "Name": "Active",
    "ArtifactID": 675,
    "Guids": []
  },
  "Keywords": "Sample keywords for a workspace",
  "Notes": "Sample notes for a workspace",
  "CreatedOn": "2018-04-24T15:19:57.677",
  "CreatedBy": {
    "Name": "Admin, Relativity",
    "ArtifactID": 9,
    "Guids": []
  },
  "LastModifiedBy": {
    "Name": "Admin, Relativity",
    "ArtifactID": 9,
    "Guids": []
  },
  "LastModifiedOn": "2020-01-09T15:51:39.13",
  "Name": "Sample workspace",
  "ArtifactID": 1017266,
  "Guids": []
}

To use this endpoint, the caller must have the following:

• Add permissions for the workspace set at the instance level. See Instance security on the RelativityOne Documentation site.

To use this endpoint, the caller must have the following:

• View permissions for workspaces set at the workspace level. See Workspace security on the RelativityOne Documentation site.

To use this endpoint, the caller must have the following:

• View Workspace Details permissions for the workspace set at the workspace level. See Workspace security on the RelativityOne Documentation site.
• View Admin Repository permissions set for Admin Operations at the instance level. Alternatively, the user must be a system admin. See Instance security on the RelativityOne Documentation site.

Note: This permission is required for the admin-level context workspace. Use -1 to indicate the admin-level context.

• ArtifactID - an integer used as a unique identifier for the workspace.
• Guids - an array of GUIDs used to identify the workspace.
• ProductionRestrictions - represents a securable saved search object used for production restrictions. See descriptions for the Secured and Value fields under Matter.

{
  "ArtifactID": 245678,
  "Guids": [
    "CE780D86-4217-45D7-83A2-0934F2F66B17"
  ],
  "Name": "New Workspace",
  "Matter": {
    "Secured": false,
    "Value": {
      "ArtifactID": 123456
    }
  },
  "Template": {
    "Secured": false,
    "Value": {
      "ArtifactID": 234567
    }
  },
  "Status": {
    "ArtifactID": 345678
  },
  "ResourcePool": {
    "Secured": false,
    "Value": {
      "ArtifactID": 456789
    }
  },
  "SqlServer": {
    "Secured": false,
    "Value": {
      "ArtifactID": 567890
    }
  },
  "DefaultFileRepository": {
    "Secured": false,
    "Value": {
      "ArtifactID": 567890
    }
  },
  "DefaultCacheLocation": {
    "Secured": false,
    "Value": {
      "ArtifactID": 567890
    }
  },
  "DownloadHandlerUrl": "Relativity.Distributed",
  "EnableDataGrid": false,
  "ProductionRestrictions": {
    "Secured": false,
    "Value": {
      "ArtifactID": 678901
    }
  },
  "DataGridFileRepository": {
    "Secured": false,
    "Value": {
      "ArtifactID": 789012
    }
  },
  "AzureCredentials": {
    "Secured": false,
    "Value": {
      "ArtifactID": 890123
    }
  },
  "AzureFileSystemCredentials": {
    "Secured": false,
    "Value": {
      "ArtifactID": 901234
    }
  },
  "SqlFullTextLanguage": "English",
  "WorkspaceAdminGroup": {
    "Secured": false,
    "Value": {
      "ArtifactID": 134567
    }
  },
  "Keywords": "",
  "Notes": ""
}

To use this endpoint, the caller must have the following:

• Edit permissions for the workspace set at the workspace level. See Workspace security on the RelativityOne Documentation site.
• View Workspace Details permissions for the workspace set at the workspace level.

Note: To update the WorkspaceAdminGroup or Matter properties, the calling user must be a system admin or client domain admin. The admin workspace can't be updated. It resides in the admin level context indicated by -1.

Note: For read-only fields, set their Secured property set to true, and set their Value properties to null. For more information, see Field permissions.

The body of request must contain a workspaceRequest object with the following fields:

• Name - the user-friendly name of the workspace.
• Matter - represents a securable matter object. A matter is the case or legal action associated with the workspace. It contains the following fields:
  • Secured - a Boolean value indicating whether the current user has permissions to view the settings in the Value field. The user can't view the Value field when this value is true. For a create request, set this value to false.
  • Value - contains the following fields:
    • ArtifactID - an integer used as a unique identifier for the object.
    • Guids - an array of GUIDs used to identify the object.

• Template - an object representing an existing workspace structure used to create the workspace. See descriptions for the Secured and Value fields under Matter.

Note: Leave the Template property blank because you can only set it at workspace creation.

• Status - represents a workspace status object associated with the workspace. It contains the following field:
  • ArtifactID - an integer used to identify the status.
• ResourcePool - represents a securable resource pool object associated with the workspace. See descriptions for the Secured and Value fields under Matter.
• SqlServer - represents a securable SQL server object associated with the workspace. See descriptions for the Secured and Value fields under Matter.
• DefaultFileRepository - represents a securable file repository server object associated with the workspace. See descriptions for the Secured and Value fields under Matter.
• DefaultCacheLocation - represents a securable cache location server object associated with the workspace. See descriptions for the Secured and Value fields under Matter.
• DownloadHandlerUrl - a string representing the default URL used to make downloaded files available to users.
• EnableDataGrid - a Boolean value indicating whether the workspace can have fields that save to Data Grid.
• ProductionRestrictions - represents a securable saved search object used for production restrictions. See descriptions for the Secured and Value fields under Matter.
• DataGridFileRepository - represents a securable file repository server object used for Data Grid. See descriptions for the Secured and Value fields under Matter.
• AzureCredentials - represents a securable Azure credentials object associated with the workspace. See descriptions for the Secured and Value fields under Matter.
• AzureFileSystemCredentials - represents a securable Azure file system credentials object associated with the workspace. See descriptions for the Secured and Value fields under Matter.
• SqlFullTextLanguage - an integer representing the ID of the language used for determining the word-break characters used in the full text index for the workspace.
• WorkspaceAdminGroup - a securable group object associated with the workspace. See descriptions for the Secured and Value fields under Matter.
• Keywords - optional words or phrases used to describe the workspace.
• Notes - additional information about the workspace.

{
  "workspaceRequest": {
    "Name": "New Workspace",
    "Matter": {
      "Secured": false,
      "Value": {
        "ArtifactID": 123456
      }
    },
    "Template": {
      "Secured": false,
      "Value": {
        "ArtifactID": 234567
      }
    },
    "Status": {
      "ArtifactID": 345678
    },
    "ResourcePool": {
      "Secured": false,
      "Value": {
        "ArtifactID": 456789
      }
    },
    "SqlServer": {
      "Secured": false,
      "Value": {
        "ArtifactID": 567890
      }
    },
    "DefaultFileRepository": {
      "Secured": false,
      "Value": {
        "ArtifactID": 567890
      }
    },
    "DefaultCacheLocation": {
      "Secured": false,
      "Value": {
        "ArtifactID": 567890
      }
    },
    "DownloadHandlerUrl": "Relativity.Distributed",
    "EnableDataGrid": false,
    "ProductionRestrictions": {
      "Secured": false,
      "Value": {
        "ArtifactID": 678901
      }
    },
    "DataGridFileRepository": {
      "Secured": false,
      "Value": {
        "ArtifactID": 789012
      }
    },
    "AzureCredentials": {
      "Secured": false,
      "Value": {
        "ArtifactID": 890123
      }
    },
    "AzureFileSystemCredentials": {
      "Secured": false,
      "Value": {
        "ArtifactID": 901234
      }
    },
    "SqlFullTextLanguage": "English",
    "WorkspaceAdminGroup": {
      "Secured": false,
      "Value": {
        "ArtifactID": 134567
      }
    },
    "Keywords": "",
    "Notes": ""
  }
}

{
  "ArtifactID": 245678,
  "Guids": [
    "CE780D86-4217-45D7-83A2-0934F2F66B17"
  ],
  "Name": "New Workspace",
  "Matter": {
    "Secured": false,
    "Value": {
      "ArtifactID": 123456
    }
  },
  "Template": {
    "Secured": false,
    "Value": {
      "ArtifactID": 234567
    }
  },
  "Status": {
    "ArtifactID": 345678
  },
  "ResourcePool": {
    "Secured": false,
    "Value": {
      "ArtifactID": 456789
    }
  },
  "SqlServer": {
    "Secured": false,
    "Value": {
      "ArtifactID": 567890
    }
  },
  "DefaultFileRepository": {
    "Secured": false,
    "Value": {
      "ArtifactID": 567890
    }
  },
  "DefaultCacheLocation": {
    "Secured": false,
    "Value": {
      "ArtifactID": 567890
    }
  },
  "DownloadHandlerUrl": "Relativity.Distributed",
  "EnableDataGrid": false,
  "ProductionRestrictions": {
    "Secured": false,
    "Value": {
      "ArtifactID": 678901
    }
  },
  "DataGridFileRepository": {
    "Secured": false,
    "Value": {
      "ArtifactID": 789012
    }
  },
  "AzureCredentials": {
    "Secured": false,
    "Value": {
      "ArtifactID": 890123
    }
  },
  "AzureFileSystemCredentials": {
    "Secured": false,
    "Value": {
      "ArtifactID": 901234
    }
  },
  "SqlFullTextLanguage": "English",
  "WorkspaceAdminGroup": {
    "Secured": false,
    "Value": {
      "ArtifactID": 134567
    }
  },
  "Keywords": "",
  "Notes": ""
}

To use this endpoint, the caller must have the following:

• View and Delete permissions for the workspace set at the workspace level. See Workspace security on the RelativityOne Documentation site.

To use this endpoint, the caller must have the following:

• View permissions for workspaces set at the workspace level. See Workspace security on the RelativityOne Documentation site.

To use this endpoint, the caller must have the following:

• View permissions for the group set at the instance level. See Instance security on the RelativityOne Documentation site.

The body of a request contains the following fields:

• request - represents the request object. It contains the following fields:
  • Fields - an array of objects describing the fields to query. Each object contains the following fields:
    • ViewFieldID - an integer used as a unique identifier for the view field.
    • ArtifactID - an integer used as a unique identifier for the field.
    • Guid - a GUID used to identify the field.
    • Name - the user-friendly name of a field.
  • Condition - the search criteria used for the query.
  • Sorts - a list of objects describing the sort rules for the results. Each object contains the following fields:
    • Field - an object describing the field. It contains the following fields:
      • ViewFieldID - an integer used as a unique identifier for the view field.
      • ArtifactID - an integer used as a unique identifier for the field.
      • Guid - a GUID used to identify the field.
      • Name - the user-friendly name of the field.
    • Direction - a string specifying whether to sort the query results in ascending or descending order. Set this field to Ascending or Descending.
  • RowCondition - the search criteria used for the query.
• start - an integer indicating the index of the first item in the query.
• length - an integer indicating the number of items to query.

{
  "request": {
    "Fields": [
      {
        "Name": "*"
      }
    ],
    "Condition": null
  },
"start": 1,
"length": 1000
}

The response contains the following fields:

• TotalCount - an integer indicating the total number of items returned by the query.
• Objects - a list of objects containing the results of a query. Each object contains the following fields:
  • ArtifactID - an integer used as a unique identifier for the object.
  • Values - an array of values for the requested fields.
• CurrentStartIndex - an integer indicating the index of the first item in the result set.
• ResultCount - an integer indicating the number of items in the result set.
• Fields - an array of objects describing fields. Each object contains the following fields:
  • FieldType - a string indicating the type of the field, such as FixedLengthText, Date, or others.
  • ViewFieldID - an integer used as a unique identifier for the view field.
  • ArtifactID - an integer used as a unique identifier for the field.
  • Guids - an array of GUIDs used to identify the field.

{
  "TotalCount": 3,
  "Objects": [
    {
      "ArtifactID": 1000002,
      "Values": [
        "Relativity Template",
        "Edit",
        "0001",
        "Relativity Template 2",
        "Active",
        "0001",
        "Admin, Relativity",
        "Admin, Relativity",
        "2007-01-01T00:00:00",
        "2008-08-05T00:36:05.54",
        "kk",
        "nn",
        1000002,
        {
          "OverwriteInheritedSecurity": false,
          "UserCanEditSecurity": false
        },
        {
          "ArtifactID": 1006066,
          "Guids": [],
          "Name": "Relativity Template 2",
          "ItemSecured": false
        },
        "Relativity Template"
      ]
    },
    {
      "ArtifactID": 1016816,
      "Values": [
        "Salt vs. Pepper",
        "Edit",
        "1",
        "Relativity",
        "Active",
        "Relativity",
        "Admin, Relativity",
        "Admin, Relativity",
        "2018-04-24T13:57:34.92",
        "2019-08-08T13:59:16.733",
        "keywords",
        "notes",
        1016816,
        {
          "OverwriteInheritedSecurity": false,
          "UserCanEditSecurity": false
        },
        {
          "ArtifactID": 1015644,
          "Guids": [],
          "Name": "Relativity",
          "ItemSecured": false
        },
        "Salt vs. Pepper"
      ]
    },
    {
      "ArtifactID": 1027403,
      "Values": [
        "Sample matter",
        "Edit",
        "12345",
        "Changed name",
        "Active",
        "Updated client number",
        "Admin, Relativity",
        "Admin, Relativity",
        "2019-11-20T15:21:51.247",
        "2019-11-20T15:21:51.247",
        "",
        "",
        1027403,
        {
          "OverwriteInheritedSecurity": false,
          "UserCanEditSecurity": false
        },
        {
          "ArtifactID": 1022225,
          "Guids": [],
          "Name": "Changed name",
          "ItemSecured": false
        },
        "Sample matter"
      ]
    }
  ],
  "IDWindow": [],
  "CurrentStartIndex": 1,
  "ResultCount": 3,
  "ObjectType": {
    "ArtifactID": 1016187,
    "Name": "Matter",
    "Guids": [],
    "ArtifactTypeID": 6
  },
  "RankWindow": [],
  "Fields": [
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 28,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Name"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "Empty",
      "ViewFieldID": 31,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Edit"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 32,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Number"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 33,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Client Name"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 35,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Status"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 45,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Client Number"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 136,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Created By"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 137,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Last Modified By"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "Date",
      "ViewFieldID": 138,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Created On"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "Date",
      "ViewFieldID": 139,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Last Modified On"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 140,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Keywords"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 141,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Notes"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "WholeNumber",
      "ViewFieldID": 1000098,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Artifact ID"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 0,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Security"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "SingleObject",
      "ViewFieldID": 1000486,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Client"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 0,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Text Identifier"
    }
  ]
}

To use this endpoint, the caller must have the following:

• View permissions for matters set at the instance level. See Instance security on the RelativityOne Documentation site.
• View Admin Repository permissions set for Admin Operations at the instance level. Alternatively, the user must be a system admin.

The body of a request contains the following fields:

• request - represents the request object. It contains the following fields:
  • Fields - an array of objects describing the fields to query. Each object contains the following fields:
    • ViewFieldID - an integer used as a unique identifier for the view field.
    • ArtifactID - an integer used as a unique identifier for the field.
    • Guid - a GUID used to identify the field.
    • Name - the user-friendly name of a field.
  • Condition - the search criteria used for the query.
  • Sorts - a list of objects describing the sort rules for the results. Each object contains the following fields:
    • Field - an object describing the field. It contains the following fields:
      • ViewFieldID - an integer used as a unique identifier for the view field.
      • ArtifactID - an integer used as a unique identifier for the field.
      • Guid - a GUID used to identify the field.
      • Name - the user-friendly name of the field.
    • Direction - a string specifying whether to sort the query results in ascending or descending order. Set this field to Ascending or Descending.
  • RowCondition - the search criteria used for the query.
• start - an integer indicating the index of the first item in the query.
• length - an integer indicating the number of items to query.

{
  "request": {
    "Fields": [
      {
        "Name": "*"
      }
    ],
    "Condition": null
  },
"start": 1,
"length": 1000
}

The response contains the following fields:

• TotalCount - an integer indicating the total number of items returned by the query.
• Objects - a list of objects containing the results of a query. Each object contains the following fields:
  • ArtifactID - an integer used as a unique identifier for the object.
  • Values - an array of values for the requested fields.
• CurrentStartIndex - an integer indicating the index of the first item in the result set.
• ResultCount - an integer indicating the number of items in the result set.
• Fields - an array of objects describing fields. Each object contains the following fields:
  • FieldType - a string indicating the type of the field, such as FixedLengthText, Date, or others.
  • ViewFieldID - an integer used as a unique identifier for the view field.
  • ArtifactID - an integer used as a unique identifier for the field.
  • Guids - an array of GUIDs used to identify the field.

{
  "TotalCount": 3,
  "Objects": [
    {
      "ArtifactID": 1000002,
      "Values": [
        "Relativity Template",
        "Edit",
        "0001",
        "Relativity Template 2",
        "Active",
        "0001",
        "Admin, Relativity",
        "Admin, Relativity",
        "2007-01-01T00:00:00",
        "2008-08-05T00:36:05.54",
        "kk",
        "nn",
        1000002,
        {
          "OverwriteInheritedSecurity": false,
          "UserCanEditSecurity": false
        },
        {
          "ArtifactID": 1006066,
          "Guids": [],
          "Name": "Relativity Template 2",
          "ItemSecured": false
        },
        "Relativity Template"
      ]
    },
    {
      "ArtifactID": 1016816,
      "Values": [
        "Salt vs. Pepper",
        "Edit",
        "1",
        "Relativity",
        "Active",
        "Relativity",
        "Admin, Relativity",
        "Admin, Relativity",
        "2018-04-24T13:57:34.92",
        "2019-08-08T13:59:16.733",
        "keywords",
        "notes",
        1016816,
        {
          "OverwriteInheritedSecurity": false,
          "UserCanEditSecurity": false
        },
        {
          "ArtifactID": 1015644,
          "Guids": [],
          "Name": "Relativity",
          "ItemSecured": false
        },
        "Salt vs. Pepper"
      ]
    },
    {
      "ArtifactID": 1027403,
      "Values": [
        "Sample matter",
        "Edit",
        "12345",
        "Changed name",
        "Active",
        "Updated client number",
        "Admin, Relativity",
        "Admin, Relativity",
        "2019-11-20T15:21:51.247",
        "2019-11-20T15:21:51.247",
        "",
        "",
        1027403,
        {
          "OverwriteInheritedSecurity": false,
          "UserCanEditSecurity": false
        },
        {
          "ArtifactID": 1022225,
          "Guids": [],
          "Name": "Changed name",
          "ItemSecured": false
        },
        "Sample matter"
      ]
    }
  ],
  "IDWindow": [],
  "CurrentStartIndex": 1,
  "ResultCount": 3,
  "ObjectType": {
    "ArtifactID": 1016187,
    "Name": "Matter",
    "Guids": [],
    "ArtifactTypeID": 6
  },
  "RankWindow": [],
  "Fields": [
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 28,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Name"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "Empty",
      "ViewFieldID": 31,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Edit"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 32,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Number"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 33,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Client Name"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 35,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Status"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 45,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Client Number"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 136,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Created By"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 137,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Last Modified By"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "Date",
      "ViewFieldID": 138,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Created On"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "Date",
      "ViewFieldID": 139,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Last Modified On"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 140,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Keywords"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 141,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Notes"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "WholeNumber",
      "ViewFieldID": 1000098,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Artifact ID"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 0,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Security"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "SingleObject",
      "ViewFieldID": 1000486,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Client"
    },
    {
      "FieldCategory": "Generic",
      "FieldType": "FixedLengthText",
      "ViewFieldID": 0,
      "ArtifactID": 0,
      "Guids": [],
      "Name": "Text Identifier"
    }
  ]
}

To use this endpoint, the caller must have the following:

• View permissions for clients set at the instance level. See Instance security on the RelativityOne Documentation site.
• View Admin Repository permissions set for Admin Operations at the instance level. Alternatively, the user must be a system admin.

To use this endpoint, the caller must have the following:

• View permissions for workspaces set at the instance level. See Instance security on the RelativityOne Documentation site.
• View Admin Repository permissions set for Admin Operations at the instance level. Alternatively, the user must be a system admin.

To use this endpoint, the caller must have the following:

• View permissions for resource pools set at the instance level. See Instance security on the RelativityOne Documentation site.
• View Admin Repository permissions set for Admin Operations at the instance level. Alternatively, the user must be a system admin.

The response contains an array of objects with the following fields:

• ArtifactID - an integer used as a unique identifier for the resource pool.
• Guids - an array of GUIDs used to identify the resource pool.
• Name - the user-friendly name of the resource pool.

[
  {
    "Name": "Default",
    "ArtifactID": 1015040,
    "Guids": []
  }
]

To use this endpoint, the caller must have the following:

• View permissions for resource pools set at the instance level. See Instance security on the RelativityOne Documentation site.

The response contains an array of objects with the following fields:

• ArtifactID - an integer used as a unique identifier for the server.
• Guids - an array of GUIDs used to identify the server.
• Name - the user-friendly name of the server.

[
  {
    "Name": "A-BC-DE-FGHIJK\\EDDSINSTANCE001",
    "ArtifactID": 1015096,
    "Guids": []
  }
]

To use this endpoint, the caller must have the following:

• View permissions for resource pools set at the instance level. See Instance security on the RelativityOne Documentation site.

The response contains an array of objects with the following fields:

• ArtifactID - an integer used as a unique identifier for the server.
• Guids - an array of GUIDs used to identify the server.
• Name - the user-friendly name of the server.

[
  {
    "Name": "\\\\A-BC-DE-FGHIJK\\fileshare\\",
    "ArtifactID": 1014887,
    "Guids": []
  }
]

To use this endpoint, the caller must have the following:

• View permissions for resource pools set at the instance level. See Instance security on the RelativityOne Documentation site.

The response contains an array of objects with the following fields:

• ArtifactID - an integer used as a unique identifier for the server.
• Guids - an array of GUIDs used to identify the server.
• Name - the user-friendly name of the server.

[
  {
    "Name": "Default Cache Location",
    "ArtifactID": 1015534,
    "Guids": []
  }
]

To use this endpoint, the caller must have the following:

• View permissions for the resource server set at the instance level. See Instance security on the RelativityOne Documentation site.
• View Admin Repository permissions set for Admin Operations at the instance level. Alternatively, the user must be a system admin.

The response contains an array of objects with the following fields:

• Name - the user-friendly name for the status.
• ArtifactID - an integer used as a unique identifier for the status.
• Guids - an array of GUIDs used to identify the status.

[
    {
        "Name": "Active",
        "ArtifactID": 675,
        "Guids": []
    }
]

To use this endpoint, the caller must have the following:

• View permissions for the resource server set at the instance level. See Instance security on the RelativityOne Documentation site.
• View Admin Repository permissions set for Admin Operations at the instance level. Alternatively, the user must be a system admin.

The response contains the following fields:

• DefaultLanguageLcid - an integer used as a unique identifier for the default language.
• Languages - an array of objects describing the supported languages. Each object contains the following fields:
  • ID - an integer used as a unique identifier for the language.
  • Name - a string representing the name of the language.

{
  "DefaultLanguageLcid": 1033,
  "Languages": [
    {
      "Name": "Arabic",
      "ID": 1025
    },
    {
      "Name": "Bengali (India)",
      "ID": 1093
    },
    {
      "Name": "Bokmål",
      "ID": 1044
    },
    {
      "Name": "Vietnamese",
      "ID": 1066
    }
  ]
}

To use this endpoint, the caller must have the following:

• View permissions for resource pools set at the instance level. See Instance security on the RelativityOne Documentation site.
• View Admin Repository permissions set for Admin Operations at the instance level. Alternatively, the user must be a system admin.

To use this endpoint, the caller must have the following:

• View permissions for workspaces set at the workspace level. See Workspace security on the RelativityOne Documentation site.

To use this endpoint, the caller must have the following:

• View permissions for resource pools set at the instance level. See Instance security on the RelativityOne Documentation site.

The response contains an array of objects with the following fields:

• ArtifactID - an integer used as a unique identifier for the Azure credentials.
• Guids - an array of GUIDs used to identify the Azure credentials.
• Name - the user-friendly name for the Azure credentials.

[
  {
    "Name": "Example",
    "ArtifactID": 1015096,
    "Guids": []
  }
]

To use this endpoint, the caller must have the following:

• View permissions for resource pools set at the instance level. See Instance security on the RelativityOne Documentation site.

The response contains an array of objects with the following fields:

• ArtifactID - an integer used as a unique identifier for the Azure credentials.
• Guids - an array of GUIDs used to identify the Azure credentials.
• Name - the user-friendly name for the Azure credentials.

[
  {
    "Name": "Example",
    "ArtifactID": 1015096,
    "Guids": []
  }
]