

Last date modified: June 17 2025
You can use the View Manager service to create, read, and update Relativity views through REST. It also includes helper endpoints for retrieving the following information:
As a sample use case, you could use the View Manager API to add or modify views used in a custom application or through the Relativity UI. For example, you might want to create a view that uses a specific set of search criteria to display custom objects in an application.
You can also use the View Manager service through .NET. For more information, see View Manager (.NET).
Review the following guidelines for working with this service.
The URLs for REST endpoints contain path parameters that you need to set before making a call:
For example, you can use the following URL to retrieve a view:
1
<host>/Relativity.Rest/API/relativity-data-visualization/{versionNumber}/workspaces/{workspaceID}/views/{viewID}
Set the path parameters as follows:
You can use the Postman sample file to become familiar with making calls to endpoints on the View Manager service. To download the sample file, click View Manager Postman file.
To get started with Postman, complete these steps:
To use the View Manager service, send requests by making calls with the required HTTP methods. You can use the following .NET code as a sample client for making calls with the View Manager service. This code illustrates how to perform the following tasks:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
public async Task<int?> CreateViewExample()
{
int? result = null; using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Add("X-CSRF-Header", "-");
client.DefaultRequestHeaders.Add("Authorization",
"Basic " + Convert.ToBase64String(Encoding.GetEncoding("ISO-8859-1").GetBytes("test@test.com:SomePassword")));
client.DefaultRequestHeaders.Add("X-Kepler-Version", "2.0");
client.BaseAddress = new Uri("https://localhost/");
string
inputJSON = "{"viewRequest":{"ArtifactTypeID":10,"ObjectType":{"Secured":false,"Value":{"ArtifactTypeID":10}},"Order":9999,"VisibleInDropdown":true,"QueryHint":"","RelativityApplications":[],"Owner":{"Secured":false,"Value":{"Name":"Public","ArtifactID":0,"Guids":[]}},"Name":"View
Name","Fields":[{"ArtifactID":1003667,"Name":"Control
Number","ViewFieldID":1000186},{"ArtifactID":1035375,"Name":"File
Size","ViewFieldID":1000574}],"Sorts":[],"Dashboard":null,"GroupDefinitionFieldArtifactID":null,"SearchCriteria":null}}";
var url = "/Relativity.REST/API/relativity-data-visualization/v1/workspaces/-1/views/";
var response = await client.PostAsync(url, new StringContent(inputJSON, Encoding.UTF8, "application/json"));
response.EnsureSuccessStatusCode();
var content = await response.Content.ReadAsStringAsync();
result = JsonConvert.DeserializeObject<int>(content);
}
return result;
}
To create a new view, send a POST request with a URL in the following format:
1
<host>/Relativity.Rest/API/relativity-data-visualization/{versionNumber}/workspaces/{workspaceID}/views
The body of the request must contain a viewRequest field, which represents a request for creating a view. The following fields are required unless specifically identified as optional:
The Sorts object contains the following fields:
To search for data, you can use a variety of query options, including conditions, fields, sorts, and relational fields. These query options have a specific syntax for defining the for defining query conditions. For information about query conditions and options, see Query for resources.
The SearchCriteria field contains the following fields based on the query provided in the sample JSON request listed in this section:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
"viewRequest": {
"ArtifactTypeID": 10,
"ObjectType": {
"Secured": false,
"Value": {
"ArtifactTypeID": 10
}
},
"Order": 9999,
"VisibleInDropdown": true,
"QueryHint": "",
"RelativityApplications": [],
"Owner": {
"Secured": false,
"Value": {
"Name": "Public",
"ArtifactID": 0,
"Guids": []
}
},
"Name": "View Name",
"Fields": [
{
"ArtifactID": 1003667,
"Name": "Control Number",
"ViewFieldID": 1000186
},
{
"ArtifactID": 1035375,
"Name": "File Size",
"ViewFieldID": 1000574
}
],
"Sorts": [],
"Dashboard": null,
"GroupDefinitionFieldArtifactID": null,
"SearchCriteria": null
}
}
The response contains the Artifact ID of the newly created view.
To retrieve the properties of a view, send a GET request with a URL in the following format:
1
<host>/Relativity.Rest/API/relativity-data-visualization/{versionNumber}/workspaces/{workspaceID}/views/{viewID}
The body of the request is empty.
The SearchCriteria field contains the following fields based on the query provided in the sample JSON request listed in this section:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
{
"ObjectIdentifier": {
"Name": "All Workspaces",
"ArtifactID": 112
},
"ObjectType": {
"Secured": false,
"Value": {
"ArtifactTypeID": 8,
"Name": "Workspace",
"ArtifactID": 0,
"Guids": []
}
},
"Owner": {
"Secured": false,
"Value": {
"Name": "",
"ArtifactID": 0,
"Guids": []
}
},
"Order": 1,
"VisibleInDropdown": true,
"QueryHint": "",
"RelativityApplications": {
"HasSecuredItems": true,
"ViewableItems": []
},
"SearchCriteria": {
"Conditions": [
{
"Condition": {
"ConditionType": "Criteria",
"Operator": "IsLike",
"FieldIdentifier": {
"ArtifactID": -1,
"ViewFieldID": 50,
"Guids": [],
"Name": "Client Name"
},
"NotOperator": true,
"Value": "Relativity Template"
},
"BooleanOperator": "Or",
"HasPermission": true
},
{
"Condition": {
"ConditionType": "Criteria",
"Operator": "Is",
"FieldIdentifier": {
"ArtifactID": 1016319,
"ViewFieldID": 46,
"Guids": [],
"Name": "Name"
},
"NotOperator": false,
"Value": "Smoke TestCase"
},
"BooleanOperator": "None",
"HasPermission": true
}
],
"BooleanOperator": "None"
},
"Fields": {
"HasSecuredItems": false,
"ViewableItems": [
{
"ArtifactID": -1,
"ViewFieldID": 53,
"Guids": [],
"Name": "Edit"
},
{
"ArtifactID": 1017488,
"ViewFieldID": 1000562,
"Guids": [
"0a813d44-a3bf-4e4e-a73d-82c89322260a"
],
"Name": "Pin"
},
{
"ArtifactID": 1016319,
"ViewFieldID": 46,
"Guids": [],
"Name": "Name"
},
{
"ArtifactID": -1,
"ViewFieldID": 50,
"Guids": [],
"Name": "Client Name"
},
{
"ArtifactID": -1,
"ViewFieldID": 54,
"Guids": [],
"Name": "Matter Name"
},
{
"ArtifactID": -1,
"ViewFieldID": 1000563,
"Guids": [],
"Name": "Instance Name"
}
]
},
"Sorts": [
{
"FieldIdentifier": {
"ArtifactID": 1016319,
"ViewFieldID": 46,
"Guids": [],
"Name": "Name"
},
"Order": 0,
"Direction": "Descending"
}
],
"CreatedBy": {
"Secured": false,
"Value": {
"Name": "Admin, Relativity",
"ArtifactID": 9,
"Guids": []
}
},
"LastModifiedBy": {
"Secured": false,
"Value": {
"Name": "Service Account, Relativity",
"ArtifactID": 777,
"Guids": []
}
},
"IsVisible": true,
"IsSystemView": false,
"IsRelationalFieldView": false,
"Dashboard": {
"Secured": true
}
}
To modify the properties of a view, send a PUT request with a URL in the following format:
1
<host>/Relativity.Rest/API/relativity-data-visualization/{versionNumber}/workspaces/{workspaceID}/views
The body of the request must contain a viewRequest field, which represents a request for creating a view. The following fields are required unless specifically identified as optional:
The Sorts object contains the following fields:
The SearchCriteria object contains the following fields based on the query provided in the sample JSON request listed in this section:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
"viewRequest": {
"ArtifactID": 1039692,
"ArtifactTypeID": 10,
"Order": 100,
"VisibleInDropdown": true,
"QueryHint": "",
"RelativityApplications": [],
"Owner": {
"ArtifactID": 0,
"Name": "Public"
},
"Name": "My View",
"Fields": [
{
"ArtifactID": 1003667,
"Name": "Control Number",
"ViewFieldID": 1000186
},
{
"ArtifactID": 1035375,
"Name": "File Size",
"ViewFieldID": 1000574
}
],
"Sorts": [
{
"FieldIdentifier": {
"ViewFieldID": 1000574,
"Name": "File Size"
},
"Direction": "Descending",
"Order": 10
}
],
"GroupDefinitionFieldArtifactID": null,
"SearchCriteria": {
"Conditions": [
{
"Condition": {
"FieldIdentifier": {
"ArtifactID": 1035375,
"Name": "File Size"
},
"ConditionType": "Criteria",
"Operator": "GreaterThan",
"NotOperator": false,
"Value": 2000
},
"BooleanOperator": "None"
}
],
"BooleanOperator": "None"
}
}
}
The response for an update operation contains the same fields as those for a read response. See the field descriptions for the response in Retrieve information about a view.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
{
"ObjectIdentifier": {
"Name": "My View",
"ArtifactID": 1039692
},
"ObjectType": {
"Secured": false,
"Value": {
"ArtifactTypeID": 10,
"Name": "Document",
"ArtifactID": 0,
"Guids": []
}
},
"Owner": {
"Secured": false,
"Value": {
"Name": "",
"ArtifactID": 0,
"Guids": []
}
},
"Order": 100,
"VisibleInDropdown": true,
"QueryHint": "",
"RelativityApplications": {
"HasSecuredItems": true,
"ViewableItems": []
},
"SearchCriteria": {
"Conditions": [
{
"Condition": {
"ConditionType": "Criteria",
"Operator": "GreaterThan",
"FieldIdentifier": {
"ArtifactID": 1035375,
"ViewFieldID": 1000574,
"Guids": [
"1287c045-cf79-44b6-8a0a-0c8d7d60d745"
],
"Name": "File Size"
},
"NotOperator": false,
"Value": 2000.0
},
"BooleanOperator": "None",
"HasPermission": true
}
],
"BooleanOperator": "None"
},
"Fields": {
"HasSecuredItems": false,
"ViewableItems": [
{
"ArtifactID": 1003667,
"ViewFieldID": 1000186,
"Guids": [
"2a3f1212-c8ca-4fa9-ad6b-f76c97f05438"
],
"Name": "Control Number"
},
{
"ArtifactID": 1035375,
"ViewFieldID": 1000574,
"Guids": [
"1287c045-cf79-44b6-8a0a-0c8d7d60d745"
],
"Name": "File Size"
}
]
},
"Sorts": [
{
"FieldIdentifier": {
"ArtifactID": 1035375,
"ViewFieldID": 1000574,
"Guids": [
"1287c045-cf79-44b6-8a0a-0c8d7d60d745"
],
"Name": "File Size"
},
"Order": 0,
"Direction": "Descending"
}
],
"CreatedBy": {
"Secured": false,
"Value": {
"Name": "Admin, Relativity",
"ArtifactID": 9,
"Guids": []
}
},
"LastModifiedBy": {
"Secured": false,
"Value": {
"Name": "Admin, Relativity",
"ArtifactID": 9,
"Guids": []
}
},
"IsVisible": true,
"IsSystemView": false,
"IsRelationalFieldView": false,
"Dashboard": {
"Secured": true
}
}
To retrieve a list of users with View permissions to a view and the fields used in the criteria for the search conditions on it, send a GET request with a URL in the following format:
1
<host>/Relativity.Rest/API/relativity-data-visualization/{versionNumber}/workspaces/{workspaceID}/views/{viewID}/access-status
The request body is empty.
The response returns the following fields:
1
2
3
4
5
{
"Exists": true,
"CanView": true,
"CanViewCriteriaFields": true
}
You can retrieve a list of users eligible to be view owners in a specific workspace. You can then use this list to assign owners to a view. To be designated as an owner, a user must have View permissions for views. For more information, see
Send a GET request with a URL in the following format:
1
<host>/Relativity.Rest/API/relativity-data-visualization/{versionNumber}/workspaces/{workspaceID}/views/{viewID}/eligible-owners
The request body is empty.
The response is an array of UserRef objects containing the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[
{
"Name": "Public",
"ArtifactID": 0,
"Guids": []
},
{
"Name": "Admin, Relativity",
"ArtifactID": 9,
"Guids": []
},
{
"Name": "Service Account, Relativity",
"ArtifactID": 777,
"Guids": []
}
]
You can retrieve a list of object types in a specific workspace. You can select an object type from this list that is used for populating the ObjectType field for the View object.
Send a GET request with a URL in the following format:
1
<host>/Relativity.Rest/API/relativity-data-visualization/{versionNumber}/workspaces/{workspaceID}/eligible-object-types
The request body is empty.
The response is an array of ObjectTypeRef objects containing the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
[
{
"ArtifactTypeID": 0,
"Name": "Analytics Categorization Result",
"ArtifactID": 0,
"Guids": []
},
{
"ArtifactTypeID": 0,
"Name": "Analytics Categorization Set",
"ArtifactID": 0,
"Guids": []
},
....
]
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!
Additional Resources |
|||
DevHelp Community | GitHub | Release Notes | NuGet |