

Last date modified: June 17 2025
These APIs don't support working with audit records stored in an SQL Server database.
Sample use cases for the Audit services include building custom applications to perform the following tasks:
You can access the Audit API services through .NET interfaces. These interfaces support the same functionality as available through REST. For more information, see Audit (.NET).
Review the following guidelines for working with the Audit services.
The URLs for REST endpoints contain path parameters that you need to set before making a call:
The following table list operations that you can perform using the Audit services.
Service name | Endpoints available for these operations |
---|---|
Audit Revert | Validate a revert operation for an audit action |
Revert an audit | |
Revert an audit | |
Audit Pivot | Query with Pivot on audit data |
Reviewer Statistics | Retrieve action counts for updated documents |
Retrieve the usage time per reviewer | |
Retrieve size of the extracted text for reviewed documents | |
Retrieve an aggregation of user actions by hour | |
Retrieve choices reviewed by users | |
Retrieve a summary report of reviewer statistics | |
Audit Query | Query for an audit record |
Audit Object Manager UI | Query on audit fields |
Query for a specific audit object | |
Query with additional query options | |
Query on audit fields and return a smaller payload |
You can specify conditions for an audit query in the condition or rowCondition fields in a JSON request. Setting these fields is equivalent to using conditions and list filtering in the Relativity UI. For information about rendering audit details in the Relativity UI, see Audit on the Relativity
1
(('Action' IN CHOICE [1048406, 1048444]))
Audit actions are Relativity choices. You can find the value of Artifact IDs of the choices on the Data Grid Audit Field Mapping tab (Relativity Choice ID Column). You can also query the choices for the Action field programmatically.
1
(('Artifact ID' == 1003663))
1
(('Audit ID' == 393901))
1
2
3
(('Timestamp' >= 2017-11-01T00:00:00.00Z AND 'Timestamp' <= 2017-11-23T23:59:00.00Z))
AND (('Object Type' == CHOICE 1048471))
AND (('Action' IN CHOICE [1048406, 1048444]))
1
(('Execution Time (ms)' > 1000))
1
(('Object Type' == CHOICE 1048471))
Object Type values are Relativity choices. You can find the value of Artifact IDs of the choices on the tab by filtering for Data Grid Audit object type and the Object Type field. You can also query the choices for the Object Type field programmatically.
1
(('New Value' LuceneSearch 'oil OR gas'))
Beginning in 10.1.169.1, Lucene Search is deprecated in Relativity.
1
(('Timestamp' >= 2017-11-01T00:00:00.00Z AND 'Timestamp' <= 2017-11-23T23:59:00.00Z))
The Audit Revert service supports reverting document update actions. It provides endpoints for reverting a single action or list of actions, and for verifying whether the revert operation can be performed on an action.
For example, you can use an endpoint on this service as a programmatic shortcut for reverting incorrect coding decisions.
To validate that an audit action can be reverted, send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/audits/revert/validate/
The request must contain the following fields:
The request requires the Timestamp and Id fields to uniquely identify the audit record.
1
2
3
4
5
6
7
{
"workspaceId": 1018053,
"request": {
"AuditId": "430133",
"Timestamp": "2019-04-25T16:05:24.867"
}
}
The response contains the following fields:
1
2
3
4
5
{
"AuditId": "1409184",
"Timestamp": "2019-05-22T15:10:42.877",
"IsRevertable": true
}
1
2
3
4
5
6
{
"AuditId": "430133",
"Timestamp": "2019-04-25T16:05:24.867",
"IsRevertable": false,
"Message": "This audit does not represent the most recent change to this document."
}
To revert an audit action, send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/audits/revert/
Before reverting an action, consider calling the ValidateRevertAuditAsync() method to verify that the revert operation can succeed.
The request contains the following fields:
The request requires the Timestamp and Id fields to uniquely identify the audit record.
1
2
3
4
5
6
7
{
"workspaceId": 1018053,
"request": {
"AuditId": "4301335",
"Timestamp": "2019-04-25T16:05:24.867"
}
}
The response contains the following fields
1
2
3
4
5
6
7
8
9
10
{
"Success": true,
"ValidationResponse": {
"AuditId": "1409184",
"Timestamp": "2019-05-22T15:10:42.877",
"IsRevertable": true,
"Message": null
},
"Message": null
}
1
2
3
4
5
6
7
8
9
10
{
"Success": false,
"ValidationResponse": {
"AuditId": "1409184",
"Timestamp": "2019-05-22T15:10:42.877",
"IsRevertable": false,
"Message": "This audit does not represent the most recent change to this document."
},
"Message": null
}
You can control the maximum number of Audits that can be reverted during a mass operation by updating the RevertMaxAuditCount instance setting. For more information, see Instance settings descriptions on the Relativity Documentation site.
This endpoint validates that each action can be successfully reverted before performing this operation.
To revert a list of audit actions, send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/audits/mass-revert/
The request must contain the following fields:
The request requires the Timestamp and Id fields to uniquely identify the audit record.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"request": {
"RevertAuditRequests": [
{
"AuditId": "1409184",
"Timestamp": "2019-05-22T15:10:42.877"
},
{
"AuditId": "1409411",
"Timestamp": "2019-05-22T15:35:01.947"
}
]
}
}
The response contains the following fields:
View a sample JSON response for reverting a list of audits
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"Success": false,
"ValidationResponses": [
{
"AuditId": "1409184",
"Timestamp": "2019-05-22T15:10:42.877",
"IsRevertable": false,
"Message": "This audit does not represent the most recent change to this document."
},
{
"AuditId": "1409411",
"Timestamp": "2019-05-22T15:35:01.947",
"IsRevertable": true,
"Message": null
}
]
}
The Audit Pivot service supports running pivot queries on audit data. You can query with the group by and pivot on operations for object type, action, username, and timestamp fields.
After the call returns the pivot results, you can render them as graphs and charts with third-party visualization tools. Pivot queries on audit records use the same query pattern as Relativity Pivot. For more information, see Pivot Manager (REST).
To query on audit pivot data, send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/pivots/
The request contains the following fields:
The use of progress indicators and cancellation tokens isn't supported, but you must include the cancel and progress fields in the 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
{
"workspaceId": 1018053,
"settings": {
"GroupBy": {
"ArtifactID": 1039619
},
"PivotOn": {
"ArtifactID": 1039617
},
"ObjectSetQuery": {
"Condition": "",
"RowCondition": "(('User Name' == CHOICE 1039872))"
},
"ConvertNumberFieldValuesToString": true,
"TimeZone": "America/Chicago"
},
"cancel": {
"RequestId": "e54e41a4-d2fb-439c-b517-1717dafc00ee",
"TicketId": "e54e41a4-d2fb-439c-b517-1717dafc00ee"
},
"progress": {
"RequestId": "e54e41a4-d2fb-439c-b517-1717dafc00ee",
"TicketId": "e54e41a4-d2fb-439c-b517-1717dafc00ee"
}
}
The response contains 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
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
{
"Results": [
{
"Timestamp": "2019-04-16T05:00:00",
"_x0039_": 5,
"_x0033_": 1,
"_x0032_8": 1,
"_x0032_": 0,
"_x0031_": 0,
"_x0033_2": 0,
"_x0032_9": 0,
"_x0033_3": 0,
"_x0033_5": 0,
"_x0031_0": 0,
"_x0035_8": 0,
"_x0035_9": 0,
"Grand Total": 7
},
{
"Timestamp": "2019-04-17T05:00:00",
"_x0039_": 0,
"_x0033_": 0,
"_x0032_8": 0,
"_x0032_": 0,
"_x0031_": 0,
"_x0033_2": 0,
"_x0032_9": 0,
"_x0033_3": 0,
"_x0033_5": 0,
"_x0031_0": 0,
"_x0035_8": 0,
"_x0035_9": 0,
"Grand Total": 0
},
{
"Timestamp": "2019-04-18T05:00:00",
"_x0039_": 0,
"_x0033_": 0,
"_x0032_8": 0,
"_x0032_": 0,
"_x0031_": 0,
"_x0033_2": 0,
"_x0032_9": 0,
"_x0033_3": 0,
"_x0033_5": 0,
"_x0031_0": 0,
"_x0035_8": 0,
"_x0035_9": 0,
"Grand Total": 0
},
...
],
"TotalCount": 37,
"QueryToken": "",
"Success": true,
"Message": "SUCCESS",
"PivotIdToDisplayValueMap": [
[
"Timestamp",
"Timestamp"
],
[
"_x0039_",
"Delete"
],
[
"_x0033_",
"Update"
],
[
"_x0032_8",
"Document Query"
],
[
"_x0032_",
"Create"
],
[
"_x0031_",
"View"
],
[
"_x0033_2",
"Import"
],
[
"_x0032_9",
"Query"
],
[
"_x0033_3",
"Export"
],
[
"_x0033_5",
"RelativityScriptExecution"
],
[
"_x0031_0",
"Security"
],
[
"_x0035_8",
"Update - Revert"
],
[
"_x0035_9",
"Update - Mass Revert"
],
[
"Grand Total",
"Grand Total"
]
]
}
The Reviewer Statistics service provides endpoints for returning information about reviewer actions, such as the number of actions performed by a reviewer on a document, the usage time per review, a summary report of reviewer actions, and others.
See the following subsections for more information:
You can retrieve the total action counts for all the updated documents in a workspace for a specified time frame. Additionally, you can list specific actions that you want counted per document. Send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/document-action-counts/
The request contains the following fields:
Name | Value |
---|---|
View | 1 |
Update | 3 |
Mass edits | 4 |
Propagation | 6 |
If you pass an empty array, the report is computed for all the users in the workspace.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"criteria": {
"AuditActionIds": [
1,
4,
3
],
"UserIds": [
9,
777
],
"StartDate": "2019-05-01T22:53:55.1169908+00:00",
"EndDate": "2019-05-22T22:54:19.7619193+00:00",
"TimeZone": "US/Central"
}
}
The response contains the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"ReviewerStatistics": [
{
"UserId": 9,
"Statistics": {
"ActionCounts": [
{
"AuditActionId": 1,
"Count": 13,
"DistinctDocumentCount": 3
},
{
"AuditActionId": 3,
"Count": 13,
"DistinctDocumentCount": 2
}
]
}
}
]
}
To compute the total usage time in seconds per reviewer, send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/usage-time/
The request contains the following fields:
If you pass an empty array, the report is computed for all the users in the workspace.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"criteria": {
"AuditActionIds": [
1,
4,
3
],
"UserIds": [
9,
777
],
"StartDate": "2019-05-01T22:53:55.1169908+00:00",
"EndDate": "2019-05-22T22:54:19.7619193+00:00",
"TimeZone": "US/Central",
"DownTime": 900
}
}
The response contains the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"ReviewerStatistics": [
{
"UserId": 777,
"Statistics": {
"TotalSeconds": 1081
}
},
{
"UserId": 9,
"Statistics": {
"TotalSeconds": 12939
}
}
]
}
To retrieve the size of the extracted text for all documents reviewed per reviewer, send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/total-reviewed-text-size/
The request contains the following fields:
If you pass an empty array, the report is computed for all the users in the workspace.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"criteria": {
"AuditActionIds": [
1,
4,
3
],
"UserIds": [
9,
777
],
"StartDate": "2019-05-01T22:53:55.1169908+00:00",
"EndDate": "2019-05-22T22:54:19.7619193+00:00",
"TimeZone": "US/Central",
"ExtractedTextFieldArtifactId": 1003668
}
}
The response contains the following fields:
1
2
3
4
5
6
7
8
9
10
{
"ReviewerStatistics": [
{
"UserId": 9,
"Statistics": {
"TotalBytes": 5312
}
}
]
}
You can aggregate the total distinct document actions performed by each reviewer, grouped by the hour of the day in which the action was performed. Send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/distinct-document-actions-per-hour-of-day/
The request contains the following fields:
If you pass an empty array, the report is computed for all the users in the workspace.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"criteria": {
"AuditActionIds": [
3,
4
],
"UserIds": [
9,
777
],
"StartDate": "2019-05-15T00:00:00.2770527-05:00",
"EndDate": "2019-05-22T00:00:00.2770527-05:00",
"TimeZone": "America/Chicago"
}
}
The response contains 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
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
{
"ReviewerStatistics": [
{
"UserId": 9,
"Statistics": {
"HourBuckets": [
{
"HourOfDay": 0,
"ActionCount": 0
},
{
"HourOfDay": 1,
"ActionCount": 0
},
{
"HourOfDay": 2,
"ActionCount": 0
},
{
"HourOfDay": 3,
"ActionCount": 0
},
{
"HourOfDay": 4,
"ActionCount": 0
},
{
"HourOfDay": 5,
"ActionCount": 0
},
{
"HourOfDay": 6,
"ActionCount": 0
},
{
"HourOfDay": 7,
"ActionCount": 0
},
{
"HourOfDay": 8,
"ActionCount": 0
},
{
"HourOfDay": 9,
"ActionCount": 0
},
{
"HourOfDay": 10,
"ActionCount": 4
},
{
"HourOfDay": 11,
"ActionCount": 0
},
{
"HourOfDay": 12,
"ActionCount": 2
},
{
"HourOfDay": 13,
"ActionCount": 0
},
{
"HourOfDay": 14,
"ActionCount": 1
},
{
"HourOfDay": 15,
"ActionCount": 4
},
{
"HourOfDay": 16,
"ActionCount": 0
},
{
"HourOfDay": 17,
"ActionCount": 0
},
{
"HourOfDay": 18,
"ActionCount": 0
},
{
"HourOfDay": 19,
"ActionCount": 0
},
{
"HourOfDay": 20,
"ActionCount": 0
},
{
"HourOfDay": 21,
"ActionCount": 0
},
{
"HourOfDay": 22,
"ActionCount": 0
},
{
"HourOfDay": 23,
"ActionCount": 0
}
]
}
}
]
}
You can retrieve information about the choices reviewed by users in a specific workspace. This endpoint supports retrieving statistics for single choice fields, multiple choice fields, and Yes/No fields. Send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/reviewer-choices/
The request contains the following fields:
If you pass an empty array for the UserIdsToExcludeInReport or the UserIdsToIncludeInReport field, the report is computed for all the users in the workspace.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"reviewerChoicesCriteria": {
"FieldIds": [
1035357
],
"EndDate": "2019-05-22T16:20:16.000",
"StartDate": "2019-05-01T16:20:16.000",
"TimeZone": "America/Chicago",
"UserIdsToExcludeInReport": [
777
],
"UserIdsToIncludeInReport": [
9
]
}
}
The response contains the following fields:
Name | Value |
---|---|
MultipleChoice | 0 |
SingleChoice | 1 |
YesOrNo | 2 |
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
{
"ReviewerStatistics": [
{
"UserId": 9,
"Statistics": {
"ReviewedFieldChoices": [
{
"FieldId": 1035357,
"ReviewedChoices": [
{
"ChoiceId": 1035871,
"Count": 0
},
{
"ChoiceId": 1035850,
"Count": 0
},
{
"ChoiceId": 1035916,
"Count": 0
},
{
"ChoiceId": 1035891,
"Count": 2
}
],
"TotalChoicesUnset": 0,
"FieldType": 1
}
],
"TotalDocsUpdated": 2,
"TotalChoicesUnset": 0
}
}
]
}
You can programmatically generate a report similar to the reviewer statistics report available through the Relativity UI. For more information, see Reviewer statistics on the Relativity
You must specify the time zone of the reviewers and indicate whether to include system admin statistics in the data.
To generate a summary report, send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/summary-report/
The request contains the following fields:
1
2
3
4
5
6
7
8
9
10
{
"reviewerStatsDataRequest": {
"startDate": "2019-01-01T00:00:00Z",
"endDate": "2019-10-05T00:00:00Z",
"timeZone": "-06.0",
"downTimeThreshold": "900",
"nonAdmin": false,
"additionalActions": "None"
}
}
The response contains the following fields:
In the following descriptions, the term distinct indicates that an action occurred only once per document.
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
[
{
"FullName": "Service Account, Relativity",
"UserId": 777,
"TotalUsageTime": "2:34:08",
"Views": 0,
"DistinctViews": 0,
"Edits": 0,
"DistinctEdits": 0,
"EditsPerHour": 0,
"EditsPerDay": 0,
"DistinctEditsPerHour": 0,
"DistinctEditsPerDay": 0,
"MassEdits": 0,
"DistinctMassEdits": 0,
"DistinctMassEditsPerHour": 0,
"DistinctMassEditsPerDay": 0,
"MassEditsPerHour": 0,
"MassEditsPerDay": 0,
"Propagations": 0,
"DistinctPropagations": 0,
"DistinctMassPropagationsPerHour": 0,
"DistinctMassPropagationsPerDay": 0,
"PropagationsPerHour": 0,
"PropagationsPerDay": 0
},
{
"FullName": "Admin, Relativity",
"UserId": 9,
"TotalUsageTime": "11:35:28",
"Views": 37,
"DistinctViews": 3,
"Edits": 31,
"DistinctEdits": 3,
"EditsPerHour": 2.67,
"EditsPerDay": 0.11,
"DistinctEditsPerHour": 0.26,
"DistinctEditsPerDay": 0.01,
"MassEdits": 0,
"DistinctMassEdits": 0,
"DistinctMassEditsPerHour": 0,
"DistinctMassEditsPerDay": 0,
"MassEditsPerHour": 0,
"MassEditsPerDay": 0,
"Propagations": 0,
"DistinctPropagations": 0,
"DistinctMassPropagationsPerHour": 0,
"DistinctMassPropagationsPerDay": 0,
"PropagationsPerHour": 0,
"PropagationsPerDay": 0
}
]
The Audit Query service supports querying for a specific audit record.
To read a single audit record, send a POST request to the following URL:
1
<host>/Relativity.REST/api/relativity-audit/{versionNumber}/workspaces/{workspaceID}/audits/
The request contains the following fields:
The request requires the Timestamp and Id fields to uniquely identify the audit record.
1
2
3
4
5
6
7
{
"workspaceId": 1018053,
"request": {
"Id": "484127",
"Timestamp": "2019-04-26T15:56:53.427"
}
}
The response contains 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
{
"ID": "484127",
"TimeStamp": "2019-04-26T15:56:53.427",
"ArtifactName": "Audit",
"ActionName": "Query",
"ActionID": 29,
"ObjectTypeName": "Workspace",
"ObjectTypeID": 8,
"ExecutionTime": 0,
"ArtifactID": 1003663,
"UserName": "Service Account, Relativity",
"UserID": 777,
"Details": {
"auditElement": {
"OperationID": "|56237733-44595bea4f441873.",
"QueryText": "SELECT * FROM EveryThing;",
"QueryParameters": {
"Parameter": [
{
"@Name": "@p1",
"#text": "1",
"@dbType": "Int"
},
{
"@Name": "@p2",
"#text": "1000011",
"@dbType": "Int"
},
{
"@Name": "@p3",
"#text": "1039633",
"@dbType": "Int"
}
]
},
"Milliseconds": "0"
}
},
"OldValues": [],
"NewValues": [],
"Fields": [],
"WorkspaceId": 1018053,
"WorkspaceName": "Audit"
}
The Audit Object Manager UI service supports querying on audit details for display in the Relativity UI. It provides two endpoints for querying:
1
<host>/Relativity.Rest/API/relativity-audit/{versionNumber}/workspaces/{workspaceID}/audits/UI/query/
1
<host>/Relativity.Rest/API/relativity-audit/{versionNumber}/workspaces/{workspaceID}/audits/UI/query-slim/
Review the following guidelines for Audit Object Manager UI service:
In Relativity instances with a very large number of audit records (1,000,000 or more), paging towards the end of the result set can cause a Deep Paging Exception.
To use the query endpoint, send a POST request to the following URL:
1
<host>/Relativity.Rest/API/relativity-audit/{versionNumber}/workspaces/{workspaceID}/audits/UI/query/
You can query for specific fields in an audit as illustrated in the following example.
The request contains the following fields:
fields - an array of fields used like a SELECT statement in an SQL query. You must specify the field name. This array contains the following:
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
{
"request": {
"fields": [
{
"Name": "User Name",
"Guids": [],
"ArtifactID": 0
},
{
"Name": "Details",
"Guids": [],
"ArtifactID": 0
},
{
"Name": "Old Value",
"Guids": [],
"ArtifactID": 0
},
{
"Name": "New Value",
"Guids": [],
"ArtifactID": 0
}
],
"condition": "",
"rowCondition": "",
"executingViewId": 1039633
},
"start": 1,
"length": 2
}
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
{
"TotalCount": 1586265,
"Objects": [
{
"ParentObject": null,
"Name": "1415378",
"FieldValues": [
{
"Value": "1415378",
"Field": {
"FieldCategory": 0,
"FieldType": 0,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Audit ID"
}
},
{
"Value": "\r\n\t\t\t\t\t\t<div>\r\n\t\t\t\t\t\t\t<a class=\"fluid-item-list-cell-link\" target=\"_top\" onclick=\"relativity.raiseCustomItemListEvent('fil_itemListFUI',1,'audit_modal_view',[1018053,'1415378','2019-05-23T02:22:37.320']);\">\r\n\t\t\t\t\t\t\t\t<img src=\"/Relativity/images/pop_up_icon.png\" alt=\"Show Audit Details\"></img>\r\n\t\t\t\t\t\t\t</a>\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t</div>",
"Field": {
"FieldCategory": 0,
"FieldType": 4,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Details"
}
}
],
"ArtifactID": 1003663,
"Guids": []
},
{
"ParentObject": null,
"Name": "1415377",
"FieldValues": [
{
"Value": "1415377",
"Field": {
"FieldCategory": 0,
"FieldType": 0,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Audit ID"
}
},
{
"Value": "\r\n\t\t\t\t\t\t<div>\r\n\t\t\t\t\t\t\t<a class=\"fluid-item-list-cell-link\" target=\"_top\" onclick=\"relativity.raiseCustomItemListEvent('fil_itemListFUI',1,'audit_modal_view',[1018053,'1415377','2019-05-23T02:22:37.290']);\">\r\n\t\t\t\t\t\t\t\t<img src=\"/Relativity/images/pop_up_icon.png\" alt=\"Show Audit Details\"></img>\r\n\t\t\t\t\t\t\t</a>\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t</div>",
"Field": {
"FieldCategory": 0,
"FieldType": 4,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Details"
}
}
],
"ArtifactID": 1003663,
"Guids": []
}
],
"IDWindow": [
1,
2
],
"CurrentStartIndex": 1,
"ResultCount": 2,
"ObjectType": {
"ArtifactID": 0,
"Name": "",
"Guids": [],
"ArtifactTypeID": 0
},
"SampleDetails": null,
"RankWindow": [
0
],
"RelationalField": null
}
You can query on a specific audit object as illustrated in the following example.
The use of progress indicators and cancellation tokens isn't supported, but you must include the cancel and progress fields in the 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
{
"request": {
"objectType": {
"artifactTypeID": 1000049
},
"fields": [
{
"Name": "Field",
"Guids": [],
"ArtifactID": 0
},
{
"Name": "Old Value",
"Guids": [],
"ArtifactID": 0
},
{
"Name": "New Value",
"Guids": [],
"ArtifactID": 0
}
],
"condition": "",
"rowCondition": "",
"sorts": [],
"relationalField": null,
"searchProviderCondition": null,
"includeIdWindow": true,
"convertNumberFieldValuesToString": true,
"isAdHocQuery": false,
"activeArtifactId": null,
"queryHint": null,
"executingViewId": 1039633
},
"start": 1,
"length": 25,
"cancel": {
"RequestId": "c8e47286-bbfa-4818-9d8d-175578a6b190",
"TicketId": "c8e47286-bbfa-4818-9d8d-175578a6b190"
},
"progress": {
"RequestId": "c8e47286-bbfa-4818-9d8d-175578a6b190",
"TicketId": "c8e47286-bbfa-4818-9d8d-175578a6b190"
}
}
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
{
"TotalCount": 1586175,
"Objects": [
{
"ParentObject": null,
"Name": "1415288",
"FieldValues": [
{
"Value": "1415288",
"Field": {
"FieldCategory": 0,
"FieldType": 0,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Audit ID"
}
},
{
"Value": "{\"auditElement\":{\"OperationID\":\"9119d82e-abcc-4b0e-931c-9e0415a81c92\",\"QueryText\":\"-- records returned: 1\\r\\n-------------------\\r\\n\",\"QueryParameters\":null,\"Milliseconds\":\"0\"}}",
"Field": {
"FieldCategory": 0,
"FieldType": 4,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Details"
}
}
],
"ArtifactID": 1003663,
"Guids": []
},
{
"ParentObject": null,
"Name": "1415287",
"FieldValues": [
{
"Value": "1415287",
"Field": {
"FieldCategory": 0,
"FieldType": 0,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Audit ID"
}
},
{
"Value": "{\"auditElement\":{\"OperationID\":\"9119d82e-abcc-4b0e-931c-9e0415a81c92\",\"QueryText\":\"-- records returned: 1\\r\\n-------------------\\r\\n\",\"QueryParameters\":null,\"Milliseconds\":\"0\"}}",
"Field": {
"FieldCategory": 0,
"FieldType": 4,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Details"
}
}
],
"ArtifactID": 1003663,
"Guids": []
}
],
"IDWindow": [
1,
2
],
"CurrentStartIndex": 1,
"ResultCount": 2,
"ObjectType": {
"ArtifactID": 0,
"Name": "",
"Guids": [],
"ArtifactTypeID": 0
},
"SampleDetails": null,
"RankWindow": [
0
],
"RelationalField": null
}
You can set additional query options so that the Details field in the Relativity UI contains an escaped JSON string instead of HTML.
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
{
"request": {
"fields": [
{
"Name": "Details",
"Guids": [],
"ArtifactID": 0
},
{
"Name": "Audit ID",
"Guids": [],
"ArtifactID": 0
},
{
"Name": "Timestamp",
"Guids": [],
"ArtifactID": 0
},
{
"Name": "Object Name",
"Guids": [],
"ArtifactID": 0
}
],
"condition": "(('Artifact ID' IN VIEW 1039633))",
"rowCondition": "",
"sorts": [],
"relationalField": null,
"searchProviderCondition": null,
"includeIdWindow": true,
"convertNumberFieldValuesToString": true,
"isAdHocQuery": false,
"activeArtifactId": null,
"queryHint": null,
"executingViewId": 1039633
},
"start": 1,
"length": 2,
"auditQueryOptions": {
"returnRawDetails": true
}
}
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
{
"TotalCount": 1586175,
"Objects": [
{
"ParentObject": null,
"Name": "1415288",
"FieldValues": [
{
"Value": "1415288",
"Field": {
"FieldCategory": 0,
"FieldType": 0,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Audit ID"
}
},
{
"Value": "{\"auditElement\":{\"OperationID\":\"9119d82e-abcc-4b0e-931c-9e0415a81c92\",\"QueryText\":\"-- records returned: 1\\r\\n-------------------\\r\\n\",\"QueryParameters\":null,\"Milliseconds\":\"0\"}}",
"Field": {
"FieldCategory": 0,
"FieldType": 4,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Details"
}
}
],
"ArtifactID": 1003663,
"Guids": []
},
{
"ParentObject": null,
"Name": "1415287",
"FieldValues": [
{
"Value": "1415287",
"Field": {
"FieldCategory": 0,
"FieldType": 0,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Audit ID"
}
},
{
"Value": "{\"auditElement\":{\"OperationID\":\"9119d82e-abcc-4b0e-931c-9e0415a81c92\",\"QueryText\":\"-- records returned: 1\\r\\n-------------------\\r\\n\",\"QueryParameters\":null,\"Milliseconds\":\"0\"}}",
"Field": {
"FieldCategory": 0,
"FieldType": 4,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Details"
}
}
],
"ArtifactID": 1003663,
"Guids": []
}
],
"IDWindow": [
1,
2
],
"CurrentStartIndex": 1,
"ResultCount": 2,
"ObjectType": {
"ArtifactID": 0,
"Name": "",
"Guids": [],
"ArtifactTypeID": 0
},
"SampleDetails": null,
"RankWindow": [
0
],
"RelationalField": null
}
To use the queryslim endpoint, send a POST request to the following URL:
1
<host>/Relativity.Rest/API/relativity-audit/{versionNumber}/workspaces/{workspaceID}/audits/UI/query-slim/
The AuditQueryOptions field isn't available for the queryslim endpoint. For more information, see Query with additional query options.
The use of progress indicators and cancellation tokens isn't supported, but you must include the cancel and progress fields in the 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
{
"request": {
"objectType": {
"artifactTypeID": 1000049
},
"fields": [
{
"Name": "Execution Time (ms)",
"Guids": [],
"ArtifactID": 0
},
{
"Name": "Object ArtifactID",
"Guids": [],
"ArtifactID": 0
},
{
"Name": "User Name",
"Guids": [],
"ArtifactID": 0
}
],
"condition": "",
"rowCondition": "",
"sorts": [],
"relationalField": null,
"searchProviderCondition": null,
"includeIdWindow": true,
"convertNumberFieldValuesToString": true,
"isAdHocQuery": false,
"activeArtifactId": null,
"queryHint": null,
"executingViewId": 1039633
},
"start": 1,
"length": 25,
"cancel": {
"RequestId": "c8e47286-bbfa-4818-9d8d-175578a6b190",
"TicketId": "c8e47286-bbfa-4818-9d8d-175578a6b190"
},
"progress": {
"RequestId": "c8e47286-bbfa-4818-9d8d-175578a6b190",
"TicketId": "c8e47286-bbfa-4818-9d8d-175578a6b190"
}
}
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
{
"TotalCount": 1586275,
"Objects": [
{
"ArtifactID": 1003663,
"Values": [
"1415388",
"\r\n\t\t\t\t\t\t<div>\r\n\t\t\t\t\t\t\t<a class=\"fluid-item-list-cell-link\" target=\"_top\" onclick=\"relativity.raiseCustomItemListEvent('fil_itemListFUI',1,'audit_modal_view',[1018053,'1415388','2019-05-23T02:23:55.650']);\">\r\n\t\t\t\t\t\t\t\t<img src=\"/Relativity/images/pop_up_icon.png\" alt=\"Show Audit Details\"></img>\r\n\t\t\t\t\t\t\t</a>\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t</div>"
]
},
{
"ArtifactID": 1003663,
"Values": [
"1415387",
"\r\n\t\t\t\t\t\t<div>\r\n\t\t\t\t\t\t\t<a class=\"fluid-item-list-cell-link\" target=\"_top\" onclick=\"relativity.raiseCustomItemListEvent('fil_itemListFUI',1,'audit_modal_view',[1018053,'1415387','2019-05-23T02:23:55.603']);\">\r\n\t\t\t\t\t\t\t\t<img src=\"/Relativity/images/pop_up_icon.png\" alt=\"Show Audit Details\"></img>\r\n\t\t\t\t\t\t\t</a>\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t</div>"
]
}
],
"IDWindow": [
1,
2
],
"CurrentStartIndex": 1,
"ResultCount": 2,
"ObjectType": null,
"SampleDetails": null,
"RankWindow": [
0
],
"RelationalField": null,
"Fields": [
{
"FieldCategory": 0,
"FieldType": 0,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Audit ID"
},
{
"FieldCategory": 0,
"FieldType": 4,
"ViewFieldID": 0,
"ArtifactID": 0,
"Guids": [],
"Name": "Details"
}
]
}
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 |