

Last date modified: July 07 2025
The Field Manager service provides multiple endpoints for programmatically working with field types supported by Relativity, including multiple choice, fixed-length text, date, and others. This service supports create, read, update, and delete operations on fields. Additionally, it includes helper endpoints for retrieving the following information:
Sample use cases for the Field Manager service include programmatically adding new fields to a custom application as data requirements change, or creating new keyboard shortcuts for fields to support modified workflows for users.
You can also use the Field Manager service through .NET. For more information, see Field Manager (.NET).
Review the following guidelines for the Field Manager 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 delete a field:
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/{fieldArtifactID}
Set the path parameters as follows:
Use the Field Manager service to work with the same field types available through the Relativity UI. For general information about fields, see Fields on the Relativity
Use the helper endpoints to facilitate creating fields.
Field type | Links to helper endpoint information |
---|---|
Date | |
Fixed-length text field | |
Multiple choice | |
Single object |
To edit properties for relational fields, the IsRelational field must be set to true. You can then edit the FriendlyName, ImportBehavior, PaneIcon, Order, and RelationalView properties. Set these fields as follows:
Set the value for the OverlayBehavior property to one of the following values. For more information, see the OverlayBehavior enumeration in the Relativity.ObjectModel.{versionNumber}.Field.Models namespace.
Set the FilterType property to one of the following values. For more information, see the FilterType enumeration in the Relativity.ObjectModel.{versionNumber}.Field.Models namespace.
The Field Manager API currently sets the filter type for the date and user fields as follows. See the following descriptions:
Only use the Source property for mapping processing fields on the Document object.
Set the Formatting property to one of the following values. For more information, see the Formatting enumeration in the Relativity.ObjectModel.{versionNumber}.Field.Models namespace.
To use the Field Manager service, send requests by making calls with the required HTTP methods. See the following base URL for this service:
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/
You can use the following .NET code as a sample client for creating a fixed-length text field. 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
23
24
25
26
27
28
29
30
31
32
33
34
35
//Create a fixed-length field.
public async Task<int?> CreateFixedLengthField(")"{
"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/");
int workspaceId = 1018486;
string fieldName ="Field Name"int objectTypeArtifactId= 1035231;
int objectTypeArtifactTypeId = 34;
string objectTypeName ="Object Type Name"int length = 255;
int fieldArtifactId = 1927383;
int choiceArtifactId = 1274939;
int associatedObjectTypeArtifactId = 1293759;
int objectViewArtifactID = 1023847;
string friendlyName ="Friendly Name""string imageFilename =""Image File Name"string imageBase64 ="iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAIpSURBVDjLddM9aFRBFIbh98zM3WyybnYVf4KSQjBJJVZBixhRixSaShtBMKUoWomgnaCxsJdgIQSstE4nEhNREgyoZYhpkogkuMa4/3fuHIu7gpLd00wz52POMzMydu/Dy958dMwYioomIIgqDa+VnWrzebNUejY/NV6nQ8nlR4ufXt0fzm2WgxUgqBInAWdhemGbpcWNN9/XN27PPb1QbRdgjEhPqap2ZUv5+iOwvJnweT1mT5djZKjI6Ej/udz+wt1OJzAKYgWyDjJWyFghmzFsbtcY2gsTJwv09/Vc7RTgAEQgsqAKaoWsM8wu/z7a8B7vA8cHD3Fr+ktFgspO3a+vrdVfNEulJ/NT4zWngCBYY1oqSghKI465fvYwW+VAatPX07IZmF7YfrC0uDE8emPmilOFkHYiBKxAxhmSRPlZVVa2FGOU2Ad2ap4zg92MDBXJZczFmdflx05VEcAZMGIIClZASdesS2cU/dcm4sTBArNzXTcNakiCb3/HLRsn4Fo2qyXh3WqDXzUlcgYnam3Dl4Hif82dbOiyiBGstSjg4majEpl8rpCNUQUjgkia0M5GVAlBEBFUwflE{versionNumber}2b/Hig6SmA1iDtzhcsE6eP7LIxAchAtwNVxc1MnhprN/+lh0txErxrPZVdFdRDEEzHT6LWpTbtq+HLSDDiOm2o1uqlyOT37bIhHdKaXoL6pqhq24Dzd96/tUYGwPSBVv7atFglaFIu5KLuPxeX/xsp7aR6AAAAAElFTkSuQmCC";
int order = 150;
string shortcutKey ="PageDown"";
string inputJSON = $""{\n\t\"fieldRequest\":{\n\t \"Name\": {{fieldName}},\n\t\t\"ObjectType\": {\n\t \"ArtifactID\": {{objectTypeArtifactId}},\n\t \"ArtifactTypeID\": {{objectTypeArtifactTypeId}},\n\t \"Name\": {{objectTypeName}}\n\t },\n\t \"Length\": {{length}},\n\t \"Source\": \"\",\n\t \"IsRequired\": false,\n\t \"IncludeInTextIndex\": false,\n\t \"HasUnicode\": false,\n\t \"AllowHtml\": false,\n\t \"OpenToAssociations\": false,\n\t \"PropagateTo\": [],\n\t \"IsLinked\": false,\n\t \"FilterType\": \"None\",\n\t \"AllowSortTally\": false,\n\t \"Width\": null, \n\t \"AllowGroupBy\": false,\n\t \"AllowPivot\": false,\n\t \"Wrapping\": false,\n\t \"IsRelational\": true,\n\t\t\"FriendlyName\": {{friendlyName}},\n\t\t\"ImportBehavior\": \"None\",\n\t\t\"PaneIcon\": {\n\t\t\t\"FileName\": {{imageFilename}},\n\t\t\t\"ImageBase64\": {{imageBase64}}\n\t\t},\n\t\t\"Order\": {{order}},\n\t\t\"RelationalView\":{\n\t \t\"Value\":{\n\t \t\t\"ArtifactID\": {{objectViewArtifactID}},\n\t \t\t\"Guids\": {{guids}}\n\t \t}\n\t },\n\t \"Shortcut\":{\n\t \"ModifierKeys\": [],\n\t \"MainKey\": \"\",\n\t},\n\t \"RelativityApplications\": [],\n\t \"Keywords\": \"\",\n \"Notes\": \"\"\n\t}\n}"";
var url = $@""/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{{workspaceID}}/fields/fixed-length"";
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;"
}
You can use the Postman sample file to become familiar with making calls to endpoints on Field Manager service. To download the sample file, click FieldAPIPostmanFile.zip.
To get started with Postman, complete these steps:
You can create a field by sending a POST request to the appropriate URL for the field type. For general information about fields, see Fields on the Relativity
Click the following drop-down links to view URLs and sample requests for fixed-length text, multiple choice, single object, and date fields. You can find the URLs and JSON request formats for other field types in the Postman file provided for this service. For more information, see Postman sample file.
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/currency
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/date
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/decimal
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/file
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/fixed-length
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/long-text
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/multiple-choice
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/multiple-object
1
<host>Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/single-choice
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/single-object
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/user
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/whole-number
1
<host>/Relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/yes-no
Depending on the field type, a request used for creating or updating a field may contain a combination of the following fields:
The requests for multiple and single choice fields have an AutoAddChoices property. If you change this property from No to Yes on a specific field, and applications in your workspace use this field, you must re-add the field to each application to include the choices. The RelativityApplications property on these requests lists the applications containing the field. See RelativityApplications in this list.
On the response object, the PropagateTo field contains the HasSecuredItems and ViewableItems fields. The ViewableItems field contains identifiers for a list of fields, which only includes unsecured items. On the request object, the PropagateTo field populates with an array of fields that the user can access. After making an update request, this array is merged with the list of fields that are secured. The secured fields aren't accessible to the user.
On the response object, the RelativityApplications field contains the HasSecuredItems and ViewableItems fields. The ViewableItems field contains identifiers for a list of applications, which only includes unsecured items. On the request object, the PropagateTo field populates with an array of applications that the user can access. After making an update request, this array is merged with the list of applications that are secured. The secured applications aren't accessible to the user.
To create a fixed-length text field, send a POST request with a URL in the following format:
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/fixed-length
The following JSON sample illustrates how to create a fixed-length text field, and set values for a relational field and keyboard shortcuts.
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
{{
"fieldRequest":{
"Name":"My Custom Fixed-length Field",
"ObjectType":{
"Secured": false,
"Value": {
"ArtifactTypeID": 10,
"Name": "Document",
"ArtifactID": 1035231,
"Guids": ["15C36703-74EA-4FF8-9DFB-AD30ECE7530D"]
}
},
"Length":100,
"Source":"",
"IsRequired":false,
"IncludeInTextIndex":false,
"HasUnicode":false,
"AllowHtml":false,
"OpenToAssociations":false,
"PropagateTo":[
],
"IsLinked":false,
"FilterType":"None",
"AllowSortTally":false,
"Width":null,
"AllowGroupBy":false,
"AllowPivot":false,
"Wrapping":false,
"IsRelational":true,
"FriendlyName":"My Custom Fixed-length Field",
"ImportBehavior":"LeaveBlankValuesUnchanged",
"PaneIcon":{
"FileName":"DuplicateIcon.png",
"ImageBase64":"iVBORw0KGgoAAAANSUhEUgAAABcAAAAdCAYAAABBsffGAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAB3RJTUUH4wUHEggE2SVNSgAAAAd0RVh0QXV0aG9yAKmuzEgAAAAMdEVYdERlc2NyaXB0aW9uABMJISMAAAAKdEVYdENvcHlyaWdodACsD8w6AAAADnRFWHRDcmVhdGlvbiB0aW1lADX3DwkAAAAJdEVYdFNvZnR3YXJlAF1w/zoAAAALdEVYdERpc2NsYWltZXIAt8C0jwAAAAh0RVh0V2FybmluZwDAG+aHAAAAB3RFWHRTb3VyY2UA9f+D6wAAAAh0RVh0Q29tbWVudAD2zJa/AAAABnRFWHRUaXRsZQCo7tInAAAAKElEQVRIie3MQQ0AAAgEILV/5zOFDzcIQCdJHZmrWC6Xy+VyuVz+Pl8ueQQ2b6MCqAAAAABJRU5ErkJggg=="
},
"Order":150,
"RelationalView":{
"Value":{
"ArtifactID":null,
"Guids":null
}
},
"Shortcut":{
"ModifierKeys":[
"Alt",
"Ctrl",
"Shift"
],
"MainKey":"Home"
},
"RelativityApplications":[
],
"Keywords":"",
"Notes":""
}
}
To create a multiple choice field, send a POST request with a URL in the following format:
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/multiple-choice
The following JSON sample illustrates how to create a multiple choice field, and set values for applications.
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
{
"fieldRequest":{
"Name": "My Multiple Choice Field",
"ObjectType": {
"Secured": false,
"Value": {
"ArtifactID": 1042378,
"Name": "Custom Object Type"
"ArtifactTypeID": 1000048,
"Guids": ["15C36703-74EA-4FF8-9DFB-AD30ECE7530D"]
}
},
"Source": "",
"IsRequired": true,
"HasUnicode": true,
"AvailableInFieldTree": false,
"OpenToAssociations": false,
"OverlayBehavior": "ReplaceValues",
"PropagateTo": [],
"IsLinked": false,
"FilterType": "None",
"AllowSortTally": false,
"Width": null,
"AllowGroupBy": false,
"AllowPivot": false,
"Wrapping": false,
"RelativityApplications": [
{
"ArtifactID": 1045231
}
],
"AutoAddChoices": false,
"Keywords": "",
"Notes": ""
}
}
To create a single object field, send a POST request with a URL in the following format:
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/single-object
The following JSON sample illustrates how to create a single object field.
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
{
"fieldRequest":{
"Name": "My Single Object Field",
"ObjectType": {
"Secured": false,
"Value": {
"ArtifactTypeID": 1000048,
"Name": "Custom Object Type"
"ArtifactID": 1042378,
"Guids": ["15C36703-74EA-4FF8-9DFB-AD30ECE7530D"]
}
},
"AssociativeObjectType": {
"Value": {
"ArtifactID": 1042580,
"ArtifactTypeID": 1000051,
"Name": "Custom Object Type Two"
}
},
"Source": "",
"IsRequired": true,
"AvailableInFieldTree": false,
"FieldTreeView":{
"Secured": false,
"Value": {
"ArtifactID": null
}
},
"OpenToAssociations": false,
"PropagateTo": [],
"IsLinked": false,
"FilterType": "Popup",
"PopupPickerView":{
"Secured": false,
"Value": {
"ArtifactID": null
}
},
"AllowSortTally": false,
"Width": null,
"AllowGroupBy": false,
"AllowPivot": false,
"Wrapping": false,
"RelativityApplications": [],
"Keywords": "",
"Notes": ""
}
}
To create a date field, send a POST request with a URL in the following format:
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/date
The following JSON sample illustrates how to create a date field, and set values for Source and Formatting fields.
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
{
"fieldRequest":{
"Name": "My Custom Date Field",
"ObjectType": {
"Secured": false,
"Value": {
"ArtifactTypeID": 1000048,
"Name": "Custom Object Type"
"ArtifactID": 1042378,
"Guids": ["15C36703-74EA-4FF8-9DFB-AD30ECE7530D"]
}
},
"Source": "Source Name",
"IsRequired": false,
"Formatting": "Date",
"OpenToAssociations": false,
"PropagateTo": [],
"IsLinked": false,
"FilterType": "None",
"AllowSortTally": false,
"Width": null,
"AllowGroupBy": false,
"AllowPivot": false,
"Wrapping": false,
"Shortcut": {
"ModifierKeys": [],
"MainKey": ""
},
"RelativityApplications": [],
"Keywords": "",
"Notes": ""
}
}
When a request is successful, the response contains the Artifact ID of the new field. It also returns the status code of 200.
You can retrieve basic or extended metadata for a field. The extended metadata also includes operations that user has permissions to perform on the field.
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/{fieldArtifactID}?includeMetadata=true&includeActions=true
The request body is empty.
Depending on the field type, a read operation returns a combination of the fields listed in Create a field. A read operation also returns the following fields:
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
{
"ObjectType":{
"Name":"Document",
"ArtifactTypeID":10,
"ArtifactID":1035231,
"Guids":[
"15c36703-74ea-4ff8-9dfb-ad30ece7530d"
]
},
"Source":{
"SourceName":"LastSavedDateTime",
"FriendlyName":"Last Saved Date/Time"
},
"FieldType":"Date",
"Length":0,
"IsRequired":false,
"IncludeInTextIndex":false,
"HasUnicode":false,
"IsIdentifier":false,
"AvailableInViewer":false,
"AvailableInFieldTree":false,
"AllowHtml":false,
"Formatting":"DateTime",
"OpenToAssociations":false,
"OverlayBehavior":"ReplaceValues",
"EnableDataGrid":false,
"PropagateTo":{
"HasSecuredItems":false,
"ViewableItems":[
{
"Name":"Family",
"ArtifactID":1003671,
"Guids":[
"1f036749-a691-4aa8-8cf7-5eeb80c36caf"
]
}
]
},
"IsLinked":false,
"FilterType":"None",
"AllowSortTally":true,
"Wrapping":true,
"AllowGroupBy":false,
"AllowPivot":false,
"Shortcut": {
"ModifierKeys": [
],
"MainKey": ""
},
"RelativityApplications":{
"HasSecuredItems":false,
"ViewableItems":[
]
},
"AutoAddChoices":false,
"CreatedOn":"2019-04-03T21:30:50.197",
"CreatedBy":{
"Name":"Doe, Jane",
"ArtifactID":1023652,
"Guids":[
]
},
"LastModifiedBy":{
"Name":"Doe, Jane",
"ArtifactID":1023652,
"Guids":[
]
},
"LastModifiedOn":"2019-04-03T21:30:50.197",
"Keywords":"",
"Notes":"",
"Name":"My New Field",
"ArtifactID":1043204,
"Guids":[
]
}
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
{
"ObjectType":{
"Name":"Document",
"ArtifactTypeID":10,
"ArtifactID":1035231,
"Guids":[
"15c36703-74ea-4ff8-9dfb-ad30ece7530d"
]
},
"Source":{
"SourceName":"LastSavedDateTime",
"FriendlyName":"Last Saved Date/Time"
},
"FieldType":"Date",
"Length":0,
"IsRequired":false,
"IncludeInTextIndex":false,
"HasUnicode":false,
"IsIdentifier":false,
"AvailableInViewer":false,
"AvailableInFieldTree":false,
"AllowHtml":false,
"Formatting":"DateTime",
"OpenToAssociations":false,
"OverlayBehavior":"ReplaceValues",
"EnableDataGrid":false,
"PropagateTo":{
"HasSecuredItems":false,
"ViewableItems":[
{
"Name":"Family",
"ArtifactID":1003671,
"Guids":[
"1f036749-a691-4aa8-8cf7-5eeb80c36caf"
]
}
]
},
"IsLinked":false,
"FilterType":"None",
"AllowSortTally":true,
"Wrapping":true,
"AllowGroupBy":false,
"AllowPivot":false,
"Shortcut": {
"ModifierKeys": [
],
"MainKey": ""
},
"RelativityApplications":{
"HasSecuredItems":false,
"ViewableItems":[
]
},
"AutoAddChoices":false,
"CreatedOn":"2019-04-03T21:30:50.197",
"CreatedBy":{
"Name":"Doe, Jane",
"ArtifactID":1023652,
"Guids":[
]
},
"LastModifiedBy":{
"Name":"Doe, Jane",
"ArtifactID":1023652,
"Guids":[
]
},
"LastModifiedOn":"2019-04-03T21:30:50.197",
"Keywords":"",
"Notes":"",
"Meta":{
"Unsupported":[
"Length",
"IncludeInTextIndex",
"AllowHtml",
"AvailableInViewer",
"EnableDataGrid",
"DisplayValueTrue",
"DisplayValueFalse",
"AvailableInFieldTree",
"HasUnicode",
"AutoAddChoices",
"OverlayBehavior",
"AssociativeObjectType",
"PopupPickerView",
"FieldTreeView"
],
"ReadOnly":[
"ObjectType",
"FieldType",
"AssociativeObjectType",
"IsIdentifier"
]
},
"Actions":[
{
"Name":"Delete",
"Href":"Relativity-Object-Model/{versionNumber}/workspaces/2342954/fields/1043204",
"Verb":"DELETE",
"IsAvailable":true,
"Reason":[
]
},
{
"Name":"Update",
"Href":"Relativity-Object-Model/{versionNumber}/workspaces/2342954/fields/1043204",
"Verb":"PUT",
"IsAvailable":true,
"Reason":[
]
}
],
"Name":"My New Field",
"ArtifactID":1043204,
"Guids":[
]
}
You can update a field by sending a PUT request to the appropriate URL for the field type. For general information about fields, see Fields on the Relativity
Click the following drop-down links to view URLs and sample requests for fixed-length text, multiple choice, single object, and date fields. You can find the URLs and JSON request formats for other field types in the Postman file provided for this service. For more information, see Postman sample file.
To view a list of field descriptions, see Create a field.
When you want to ensure you only update a field if it hasn't been modified since you read it, provide the LastModifiedOn field. The update will fail if the field has been changed in the meantime and return a 409 error. You can get the value of this property from an FieldResponse object, which is returned by the ReadAsync() method.
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/currency/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/date/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/decimal/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/file/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/fixed-length/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/long-text/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/multiple-choice/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/multiple-object/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/single-choice/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/single-object/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/user/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/whole-number/{fieldArtifactID}
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/yes-no/{fieldArtifactID}
To update a fixed-length text field, send a PUT request with a URL in the following format:
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/fixed-length/{fieldArtifactID}
The following JSON illustrates a sample request:
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
{
"fieldRequest":{
"Name": "Updated Fixed-length Field",
"ObjectType": {
"Secured": false,
"Value": {
"ArtifactTypeID": 10,
"Name": "Document",
"ArtifactID": 1035231,
"Guids": ["15C36703-74EA-4FF8-9DFB-AD30ECE7530D"]
}
},
"Length": 100,
"Source": "",
"IsRequired": false,
"IncludeInTextIndex": false,
"HasUnicode": false,
"AllowHtml": false,
"OpenToAssociations": false,
"PropagateTo": [],
"IsLinked": false,
"FilterType": "None",
"AllowSortTally": false,
"Width": null,
"AllowGroupBy": false,
"AllowPivot": false,
"Wrapping": false,
"IsRelational": true,
"FriendlyName": "My Custom Fixed-length Field",
"ImportBehavior": "LeaveBlankValuesUnchanged",
"PaneIcon": {
"FileName": "DuplicateIcon.png",
"ImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABcAAAAdCAYAAABBsffGAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAB3RJTUUH4wUHEggE2SVNSgAAAAd0RVh0QXV0aG9yAKmuzEgAAAAMdEVYdERlc2NyaXB0aW9uABMJISMAAAAKdEVYdENvcHlyaWdodACsD8w6AAAADnRFWHRDcmVhdGlvbiB0aW1lADX3DwkAAAAJdEVYdFNvZnR3YXJlAF1w/zoAAAALdEVYdERpc2NsYWltZXIAt8C0jwAAAAh0RVh0V2FybmluZwDAG+aHAAAAB3RFWHRTb3VyY2UA9f+D6wAAAAh0RVh0Q29tbWVudAD2zJa/AAAABnRFWHRUaXRsZQCo7tInAAAAKElEQVRIie3MQQ0AAAgEILV/5zOFDzcIQCdJHZmrWC6Xy+VyuVz+Pl8ueQQ2b6MCqAAAAABJRU5ErkJggg=="
},
"Order": 150,
"RelationalView":{
"Value":{
"ArtifactID": null,
"Guids": null
}
},
"Shortcut": {
"ModifierKeys": [
],
"MainKey": ""
},
"RelativityApplications": [],
"Keywords": "",
"Notes": "Updated the field"
}
}
To update a multiple choice field, send a PUT request with a URL in the following format:
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/multiple-choice/{fieldArtifactID}
The following JSON illustrates a sample request:
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
{
"fieldRequest":{
"Name": "My Updated Choice Field",
"ObjectType": {
"Secured": false,
"Value": {
"ArtifactTypeID": 1000048,
"Name": "Custom Object Type"
"ArtifactID": 1042378,
"Guids": ["15C36703-74EA-4FF8-9DFB-AD30ECE7530D"]
}
},
"Source": "",
"IsRequired": true,
"HasUnicode": true,
"AvailableInFieldTree": false,
"OpenToAssociations": false,
"OverlayBehavior": "MergeValues",
"PropagateTo": [],
"IsLinked": false,
"FilterType": "None",
"AllowSortTally": false,
"Width": null,
"AllowGroupBy": false,
"AllowPivot": false,
"Wrapping": false,
"RelativityApplications": [],
"AutoAddChoices": false,
"Keywords": "",
"Notes": ""
}
}
To update a single object field, send a PUT request with a URL in the following format:
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/single-object/{fieldArtifactID}
The following JSON illustrates a sample request:
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
{
"fieldRequest":{
"Name": "Updated Single Object Field",
"ObjectType": {
"Secured": false,
"Value": {
"ArtifactTypeID": 1000048,
"Name":"Custom Object Type"
"ArtifactID": 1042378,
"Guids": ["15C36703-74EA-4FF8-9DFB-AD30ECE7530D"]
}
},
"AssociativeObjectType": {
"Value": {
"ArtifactID": 1042580,
"ArtifactTypeID": 1000051,
"Name": "Custom Object Type Two"
}
},
"Source": "",
"IsRequired": true,
"AvailableInFieldTree": false,
"FieldTreeView":{
"Secured": false,
"Value": {
"ArtifactID": null
}
},
"OpenToAssociations": false,
"PropagateTo": [],
"IsLinked": false,
"FilterType": "Popup",
"PopupPickerView":{
"Secured": false,
"Value": {
"ArtifactID": null
}
},
"AllowSortTally": false,
"Width": null,
"AllowGroupBy": false,
"AllowPivot": false,
"Wrapping": false,
"RelativityApplications": [
{
"ArtifactID":1042630,
"Guids":[]
}
],
"Keywords": "",
"Notes": "Updated single object field."
}
}
To update a date field, send a PUT request with a URL in the following format:
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/date/{fieldArtifactID}
The following JSON illustrates a sample request:
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
{
"fieldRequest":{
"Name": "Updated Custom Date Field",
"ObjectType": {
"Secured": false,
"Value": {
"ArtifactTypeID":1000048,
"Name": "Custom Object Type"
"ArtifactID": 1042378,
"Guids": ["15C36703-74EA-4FF8-9DFB-AD30ECE7530D"]
}
},
"Source": "",
"IsRequired": false,
"Formatting": "Date",
"OpenToAssociations": false,
"PropagateTo": [],
"IsLinked": false,
"FilterType": "None",
"AllowSortTally": false,
"Width": null,
"AllowGroupBy": false,
"AllowPivot": false,
"Wrapping": false,
"Shortcut": {
"ModifierKeys": [
],
"MainKey": ""
},
"RelativityApplications": [
{
"ArtifactID":1042630,
"Guids":[]
}
],
"Keywords": "",
"Notes": "Updated data field"
}
}
When the field is successfully updated, the response returns the status code of 200.
To remove a field from Relativity, send a POST request with a URL in the following format:
1
<host>/relativity.rest/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/{fieldArtifactID}
The request body is empty.
When the field is successfully deleted, the response returns the status code of 200.
You create fields on object types available in a workspace. To retrieve parent object types in a specific workspace, send a GET request with a URL in the following format:
1
<host>/Relativity.REST/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/available-object-types
The request body is empty.
The response contains the following fields for each object type:
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
[
{
"Name": "Custom Object Type",
"ArtifactTypeID": 1000048,
"ArtifactID": 1042378,
"Guids": []
},
{
"Name": "Custom Object Type Two",
"ArtifactTypeID": 1000051,
"ArtifactID": 1042580,
"Guids": []
},
{
"Name": "Custom Page",
"ArtifactTypeID": 1000023,
"ArtifactID": 1036920,
"Guids": []
},
{
"Name": "Dashboard",
"ArtifactTypeID": 1000033,
"ArtifactID": 1037793,
"Guids": [
"de1b78ff-b4c3-4e10-b01f-7065bcffa4b8"
]
},
{
"Name": "Document",
"ArtifactTypeID": 10,
"ArtifactID": 1035231,
"Guids": [
"15c36703-74ea-4ff8-9dfb-ad30ece7530d"
]
},
{
"Name": "Filter Set",
"ArtifactTypeID": 1000034,
"ArtifactID": 1037985,
"Guids": [
"25d34209-0930-488a-9295-8a5f398fb3f2"
]
},
{
"Name": "Relativity Application",
"ArtifactTypeID": 1000011,
"ArtifactID": 1035572,
"Guids": []
},
{
"Name": "Relativity Time Zone",
"ArtifactTypeID": 1000022,
"ArtifactID": 1036668,
"Guids": [
"bc411c4d-285a-466b-8824-e084fd981f8b"
]
},
{
"Name": "Search Terms Report",
"ArtifactTypeID": 1000006,
"ArtifactID": 1035313,
"Guids": [
"481e9acf-368b-4341-b6b5-a21153ad9950"
]
},
{
"Name": "Search Terms Result",
"ArtifactTypeID": 1000007,
"ArtifactID": 1035324,
"Guids": [
"f1d86fc1-638a-48b3-a1ef-5fce03b40ce4"
]
},
{
"Name": "Transform",
"ArtifactTypeID": 1000005,
"ArtifactID": 1035296,
"Guids": [
"c5a7f07a-2b12-4bc5-8e7d-e51526a9cf30"
]
},
{
"Name": "Transform Set",
"ArtifactTypeID": 1000004,
"ArtifactID": 1035285,
"Guids": [
"6ffa970a-e8b0-4f53-a674-12ffaf4c60d4"
]
}
]
You can retrieve a list of available views for a specific object type that you can then use when creating or updating a new field. The following endpoint is used to retrieve this information for the field tree, pop-up picker, and relational views. The relational view is available only for documents. For more information, see Fields on the Relativity
Send a POST request with a URL in the following format:
1
<host>/Relativity.REST/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/available-object-type-views
The request contains the following fields:
1
2
3
4
5
6
7
{
"ObjectType":{
"ArtifactID":1035231,
"ArtifactTypeID":10,
"Name":"Document"
}
}
The response contains the following fields for each 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
[
{
"Secured": false,
"Value": {
"Name": "CaseMap Fields View",
"ArtifactID": 1034267,
"Guids": []
}
},
{
"Secured": false,
"Value": {
"Name": "Default Search View",
"ArtifactID": 1003691,
"Guids": []
}
},
{
"Secured": false,
"Value": {
"Name": "Documents",
"ArtifactID": 1003684,
"Guids": [
"67f18ef0-2da2-4980-9519-a49392a321b3"
]
}
},
{
"Secured": false,
"Value": {
"Name": "Duplicates Documents",
"ArtifactID": 1036632,
"Guids": [
"94c640e3-783c-484d-b9d1-758f76460a90"
]
}
},
{
"Secured": false,
"Value": {
"Name": "Family Documents",
"ArtifactID": 1036633,
"Guids": [
"8b9dc379-ef1d-4aaf-a0c5-a647879943c9"
]
}
},
{
"Secured": false,
"Value": {
"Name": "Link Pane View",
"ArtifactID": 1035254,
"Guids": []
}
},
{
"Secured": false,
"Value": {
"Name": "Linked",
"ArtifactID": 1035245,
"Guids": []
}
},
{
"Secured": false,
"Value": {
"Name": "OCR Documents",
"ArtifactID": 1035427,
"Guids": [
"98c0e1eb-828d-4004-af9c-8046893cebcb"
]
}
},
{
"Secured": false,
"Value": {
"Name": "Production Documents",
"ArtifactID": 1003692,
"Guids": []
}
},
{
"Secured": false,
"Value": {
"Name": "Search Results Pane View",
"ArtifactID": 1034263,
"Guids": []
}
}
]
When creating a field, you can determine whether coding values propagate to a specific group of related items. For more information about propagation, see Fields on the Relativity
To retrieve the fields used for propagation in a workspace, send a POST request with a URL in the following format:
1
<host>/Relativity.REST/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/available-propagate-to-fields
The request body is empty.
The response contains the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[
{
"Name": "Duplicates",
"ArtifactID": 1003669,
"Guids": [
"a426bc5e-3420-47b4-a293-4c4848a237d7"
]
},
{
"Name": "Family",
"ArtifactID": 1003671,
"Guids": [
"1f036749-a691-4aa8-8cf7-5eeb80c36caf"
]
}
]
You can retrieve an array of object types that you can use to create a single object field type. For more information about single object fields, see Fields on the Relativity
Send a POST request with a URL in the following format:
1
<host>/Relativity.REST/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/available-single-associative-object-types
The request contains the following fields:
1
2
3
4
5
6
7
{
"ObjectType":{
"ArtifactID":1035231,
"ArtifactTypeID":10,
"Name":"Document"
}
}
The response contains the following fields for each object type:
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
[
{
"Name": "Analytics Example",
"ArtifactTypeID": 1000020,
"ArtifactID": 1036417,
"Guids": [
"1f61cd9a-dacc-4e05-a5a3-8bf25baf7c22"
]
},
{
"Name": "Custom Object Type",
"ArtifactTypeID": 1000048,
"ArtifactID": 1042378,
"Guids": []
},
{
"Name": "Custom Object Type Two",
"ArtifactTypeID": 1000051,
"ArtifactID": 1042580,
"Guids": []
},
{
"Name": "Custom Page",
"ArtifactTypeID": 1000023,
"ArtifactID": 1036920,
"Guids": []
},
{
"Name": "Dashboard",
"ArtifactTypeID": 1000033,
"ArtifactID": 1037793,
"Guids": [
"de1b78ff-b4c3-4e10-b01f-7065bcffa4b8"
]
},
{
"Name": "Document",
"ArtifactTypeID": 10,
"ArtifactID": 1035231,
"Guids": [
"15c36703-74ea-4ff8-9dfb-ad30ece7530d"
]
},
{
"Name": "Filter Set",
"ArtifactTypeID": 1000034,
"ArtifactID": 1037985,
"Guids": [
"25d34209-0930-488a-9295-8a5f398fb3f2"
]
},
{
"Name": "Imaging Document Error",
"ArtifactTypeID": 1000044,
"ArtifactID": 1039765,
"Guids": [
"eb546506-1014-487c-959e-3c4cbff7e3f5"
]
},
{
"Name": "Imaging Profile",
"ArtifactTypeID": 1000015,
"ArtifactID": 1035671,
"Guids": [
"c6fac105-3493-4551-b956-4757066e622f"
]
},
{
"Name": "Imaging Set",
"ArtifactTypeID": 1000016,
"ArtifactID": 1035691,
"Guids": [
"ba574e88-7408-4434-a688-2324ecfc769e"
]
},
{
"Name": "Imaging Warning",
"ArtifactTypeID": 1000046,
"ArtifactID": 1040023,
"Guids": [
"cfc3e5b9-b0dd-4c54-8937-a74334d33830"
]
}
]
You can retrieve an array of associative object types that you can use to create a multiple object field. For more information about multiple object fields, see Fields on the Relativity
Send a POST request with a URL in the following format:
1
<host>Relativity.REST/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/available-multi-associative-object-types
The request contains the following fields:
1
2
3
4
5
6
7
{
"ObjectType":{
"ArtifactID":1035231,
"ArtifactTypeID":10,
"Name":"Document"
}
}
The response contains the following fields for each object type:
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
[
{
"Name": "Analytics Example",
"ArtifactTypeID": 1000020,
"ArtifactID": 1036417,
"Guids": [
"1f61cd9a-dacc-4e05-a5a3-8bf25baf7c22"
]
},
{
"Name": "Custom Object Type",
"ArtifactTypeID": 1000048,
"ArtifactID": 1042378,
"Guids": []
},
{
"Name": "Custom Object Type Two",
"ArtifactTypeID": 1000051,
"ArtifactID": 1042580,
"Guids": []
},
{
"Name": "Custom Page",
"ArtifactTypeID": 1000023,
"ArtifactID": 1036920,
"Guids": []
},
{
"Name": "Dashboard",
"ArtifactTypeID": 1000033,
"ArtifactID": 1037793,
"Guids": [
"de1b78ff-b4c3-4e10-b01f-7065bcffa4b8"
]
},
{
"Name": "Document",
"ArtifactTypeID": 10,
"ArtifactID": 1035231,
"Guids": [
"15c36703-74ea-4ff8-9dfb-ad30ece7530d"
]
},
{
"Name": "Repeated Content Filter",
"ArtifactTypeID": 1000013,
"ArtifactID": 1035630,
"Guids": [
"e978b89b-2111-441e-8771-0cf42a41a8f6"
]
},
{
"Name": "Search Terms Report",
"ArtifactTypeID": 1000006,
"ArtifactID": 1035313,
"Guids": [
"481e9acf-368b-4341-b6b5-a21153ad9950"
]
},
{
"Name": "Search Terms Result",
"ArtifactTypeID": 1000007,
"ArtifactID": 1035324,
"Guids": [
"f1d86fc1-638a-48b3-a1ef-5fce03b40ce4"
]
},
{
"Name": "Transform",
"ArtifactTypeID": 1000005,
"ArtifactID": 1035296,
"Guids": [
"c5a7f07a-2b12-4bc5-8e7d-e51526a9cf30"
]
},
{
"Name": "Transform Set",
"ArtifactTypeID": 1000004,
"ArtifactID": 1035285,
"Guids": [
"6ffa970a-e8b0-4f53-a674-12ffaf4c60d4"
]
}
]
You can retrieve a list of keyboard shortcuts currently defined in a workspace. In the Relativity UI, this list is displayed when you click the Keyboard Shortcuts Legend icon. For more information, see
Send a POST request with a URL in the following format:
1
<host>/Relativity.REST/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/available-keyboard-shortcuts
The request body is empty.
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
[
{
"Shortcut": "Alt+Down Arrow",
"Action": "Next Highlight",
"ViewerMode": "Long Text, Viewer",
"Category": "System"
},
{
"Shortcut": "Alt+E",
"Action": "Switch to Long Text Mode",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+End",
"Action": "Last Document",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+Enter",
"Action": "Save and Next",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+Home",
"Action": "First Document",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+I",
"Action": "Switch to Image Mode",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+Left Arrow",
"Action": "Page Up/Previous Image",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+M",
"Action": "Toggle Modes (Draft/Normal/Preview)",
"ViewerMode": "Long Text, Viewer",
"Category": "System"
},
{
"Shortcut": "Alt+N",
"Action": "Switch to Native Mode",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+P",
"Action": "Switch to Productions Mode",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+Page Down",
"Action": "Next Document",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+Page Up",
"Action": "Previous Document",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+Right Arrow",
"Action": "Page Down/Next Image",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+S",
"Action": "Save",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+Shift+Z",
"Action": "Copy From Previous",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+Space",
"Action": "Edit",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+Up Arrow",
"Action": "Previous Highlight",
"ViewerMode": "Long Text, Viewer",
"Category": "System"
},
{
"Shortcut": "Alt+V",
"Action": "Switch to Viewer Mode",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Alt+Z",
"Action": "Cancel",
"ViewerMode": "All",
"Category": "System"
},
{
"Shortcut": "Ctrl+A",
"Action": "Select All",
"ViewerMode": "All",
"Category": "Browser"
},
{
"Shortcut": "Ctrl+C",
"Action": "Copy",
"ViewerMode": "All",
"Category": "Browser"
},
{
"Shortcut": "Ctrl+F",
"Action": "Find",
"ViewerMode": "All",
"Category": "Browser"
},
{
"Shortcut": "Ctrl+P",
"Action": "Print",
"ViewerMode": "All",
"Category": "Browser"
},
{
"Shortcut": "Ctrl+Shift+T",
"Action": "Reopen Last Tab",
"ViewerMode": "All",
"Category": "Browser"
},
{
"Shortcut": "Ctrl+T",
"Action": "New Tab",
"ViewerMode": "All",
"Category": "Browser"
},
{
"Shortcut": "Ctrl+V",
"Action": "Paste",
"ViewerMode": "All",
"Category": "Browser"
},
{
"Shortcut": "Ctrl+X",
"Action": "Cut",
"ViewerMode": "All",
"Category": "Browser"
}
]
When creating or updating a field on a Document object, you can assign a keyboard shortcut to it. The shortcut key is a combination of a CTRL, ALT, or SHIFT key, and an alphanumeric or other key. For more information, see Fields on the Relativity
You can use the following endpoint to retrieve all keys available for use when creating a keyboard shortcut. Send a GET request with a URL in the following format:
1
<host>/Relativity.REST/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/valid-keys
The request body is empty.
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
[
"Return",
"Space",
"PageUp",
"PageDown",
"End",
"Home",
"LeftArrow",
"UpArrow",
"RightArrow",
"DownArrow",
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"Y",
"Z",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
]
You can retrieve the current order for relational field icons displayed in the Related Items pane of the core reviewer interface. The order assigned to a relational field icon determines its position relative to other icons in the Related Items pane. A relational field icon with a lower order number is displayed on the left, while those with the same order number are sorted alphanumerically.
In the Relativity UI, you can add or edit fields in the Fields layout, which contains the View Order button for relational field properties. Click this button to display the current order for icons in the Related Items pane. For more information, see Fields on the Relativity
To retrieve the current display order for the icons of relational fields available in a specific workspace, send a GET request with a URL in the following format:
1
<host>/Relativity.REST/api/Relativity-Object-Model/{versionNumber}/workspaces/{workspaceID}/fields/available-relational-order
The request body is empty.
The response contains the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[
{
"Name": "Family",
"Type": "GroupIdentifier",
"Order": 0
},
{
"Name": "Duplicates",
"Type": "MD5Hash",
"Order": 1
},
{
"Name": "My Test Relational",
"Type": "TestRelational",
"Order": 10
}
]
On this page
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 |