Audit (REST)

• Action
  Copy

  1
  (('Action' IN CHOICE [1048406, 1048444]))

  Note: 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.

• Artifact ID - the ID of the Relativity artifact associated with the audit record.
  Copy

  1
  (('Artifact ID' == 1003663))

• Audit record ID
  Copy

  1
  (('Audit ID' == 393901))

• Complex condition - an example is a complex condition that combines date, object type, and action.
  Copy

  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]))

• Execution Time (in milliseconds)
  Copy

  1
  (('Execution Time (ms)' > 1000))

• Object type
  Copy

  1
  (('Object Type' == CHOICE 1048471))

  Note: 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.

• Old value or new value
  Copy

  1
  (('New Value' LuceneSearch 'oil OR gas'))

  Note: Beginning in 10.1.290.1, Lucene Search is deprecated in Relativity.

• Timestamp
  Copy

  1
  (('Timestamp' >= 2017-11-01T00:00:00.00Z AND 'Timestamp' <= 2017-11-23T23:59:00.00Z))

The request must contain the following fields:

• workspaceId - the Artifact ID of the workspace containing the action that you want to revert. This field is optional in the request. If a mismatch occurs between the ID in this field and the URL, then the ID in the URL is used in the request.
• request - represents a request to revert an action. It contains the following fields:
  • AuditId - the identifier assigned by Relativity to an audit action.
  • Timestamp - the date and time of the audit action.

    Note: 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:

• AuditId - the identifier assigned by Relativity to an audit.
• Timestamp - the date and time of the audit action.
• IsRevertable - a Boolean value indicating whether you can revert an audit action.
• Message - information explaining why an audit action can't be reverted.

An audit that can be reverted

1
2
3
4
5
{
    "AuditId": "1409184",
    "Timestamp": "2019-05-22T15:10:42.877",
    "IsRevertable": true
}

An audit that can't be reverted

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."
}

The request contains the following fields:

• workspaceId - the Artifact ID of the workspace containing the action that you want to revert. This field is optional in the request. If a mismatch occurs between the ID in this field and the URL, then the ID in the URL is used in the request.
• request - represents a request to revert an action. It contains the following fields:
  • AuditId - the identifier assigned by Relativity to an audit action.
  • Timestamp - the date and time of the audit action.

    Note: 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

• Success - a Boolean value indicating whether the action was reverted.

• ValidationResponse - contains the following fields:
  • AuditId - the identifier assigned by Relativity to an audit.
  • Timestamp - the date and time of the audit action.
  • IsRevertable - a Boolean value indicating whether the audit action was reverted.
  • Message - information explaining why an audit action can't be reverted.

• Message - additional information about the revert operation.

A reverted audit

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
}

An audit that can't be reverted

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
}

The request must contain the following fields:

• Request - represents a request to revert multiple actions. It contains the following fields:
  • RevertAuditRequests - an array of audit actions to revert. Each audit action includes the following fields:
    • AuditId - the identifier assigned by Relativity to an audit.
    • Timestamp - the date and time of the audit action.

      Note: 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:

• Success - a Boolean value indicating whether the action was reverted.

• ValidationResponses - contains the following fields for each action:
  • AuditId - the identifier assigned by Relativity to an audit.
  • Timestamp - the date and time of the audit action.
  • IsRevertable - a Boolean value indicating whether the audit action was reverted.
  • Message - information explaining why an audit action can't be reverted.

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 request contains the following fields:

• workspaceId - the Artifact ID of the target workspace. This field is optional in the request. If a mismatch occurs between the ID in this field and the URL, then the ID in the URL is used in the request.
• settings - represents the pivot fields to query. It contains the following fields:
  • GroupBy - the Artifact ID of the object to group by, such as the audit action or username.
  • PivotOn - the Artifact ID of the field to use as the pivot on value in the query and result set. For example, you might use the audit action, object type, or username. The field must have pivot functionality enabled on it.
  • ObjectSetQuery - defines a base set of documents or objects to run a Pivot query against. You can use the following properties on the ObjectSetQuery object for filtering:
    • Condition - the search criteria used in the query. This field is optional.
    • RowCondition - a filtering condition criteria for the result set. This field is optional. For example, you might set this field as follows: "RowCondition": "((('Audit ID' LIKE ['1409579'])))".
  • ConvertNumberFieldValuesToString - a Boolean value indicating whether to convert response field values to strings. This field is optional.
  • TimeZone - a time zone URL.
• cancel - a required field that contains the following:
  • RequestId - a GUID.
  • TicketId - a GUID.
• progress - a required field that contains the following:
  • RequestId - a GUID.
  • TicketId - a GUID.

Note: The use of progress indicators and cancellation tokens isn't supported, but you must include the cancel and progress fields in the request.

The response contains the following fields:

• Results - an array of items that meet the criteria specified in the pivot query.
  • Timestamp - the date and time of the audit action.
  • List of data
  • Grand Total - the number of data elements.
• TotalCount - the total number of results returned by the pivot.
• QueryToken - reserved for future use.
• Success - a Boolean value indicating whether the query succeeded.
• Message - a message indicating the status of a pivot query. If the query failed, the message contains information about the errors that occurred.
• PivotIdToDisplayValueMap - if a PivotOn field is specified in the request, the object maps the system-generated pivot item IDs to display values for visualization.

The request contains the following fields:

• criteria - represents the actions, users, and timeframe used when retrieving counts for audit actions. It contains the following fields:
  • AuditActionIds - an array of identifiers for the audit actions performed on document. This endpoint retrieves the counts for the following supported actions:

    Name	Value
    View	1
    Update	3
    Mass edits	4
    Propagation	6

  • UserIds - an array of Artifact IDs for Relativity users whose audit actions are included in the report.

    Note: If you pass an empty array, the report is computed for all the users in the workspace.

  • StartDate - the initial date for the reporting period.
  • EndDate - the final date for the reporting period.
  • TimeZone - a time zone URL.

The response contains the following fields:

• ReviewerStatistics - includes information returned for specific reviewer criteria. It contains the following fields:
  • UserId - the Artifact ID for a Relativity user.
  • Statistics -includes information about the action counts returned. It contains the following field:
    • ActionCounts - an array of counts returned for a user. It contains the following fields:
      • AuditActionId - the identifier for an audit actions performed on document.
      • Count - the total number of actions performed on a document object.
      • DistinctDocumentCount - the total number of actions performed on distinct documents.

The request contains the following fields:

• criteria - represents the actions, users, and timeframe used when retrieving counts for usage times. It contains the following fields:
  • AuditActionIds - an array of identifiers for the audit actions performed on document.
  • UserIds - an array of Artifact IDs for Relativity users whose audit actions are included in the report.

    Note: If you pass an empty array, the report is computed for all the users in the workspace.

  • StartDate - the initial date for the reporting period.
  • EndDate - the final date for the reporting period.
  • TimeZone - a time zone URL.
  • DownTime - the number of seconds used to determine whether a null session action should be joined to a non-null session action. If the time difference for the performance of a null session action is larger than this maximum duration, the null session is counted as one minute. The default value is 900 secs.

The response contains the following fields:

• ReviewerStatistics - includes information returned for specific reviewer criteria. It contains the following fields:
  • UserId - the Artifact ID for a Relativity user.
  • Statistics - includes information about the usage time. It contains the following field:
    • TotalSeconds - the total number of seconds that a reviewer used to complete the specified actions.

The request contains the following fields:

• criteria - represents the actions, users, and timeframe used when retrieving the size of extracted text for reviewed documents. It contains the following fields:
  • AuditActionIds - an array of identifiers for the audit actions performed on document.
  • UserIds - an array of Artifact IDs for Relativity users whose audit actions are included in the report.

    Note: If you pass an empty array, the report is computed for all the users in the workspace.

  • StartDate - the initial date for the reporting period.
  • EndDate - the final date for the reporting period.
  • TimeZone - a time zone URL.
  • ExtractedTextFieldArtifactId - the Artifact ID of an extracted text field in the specified workspace.

The response contains the following fields:

• ReviewerStatistics - includes information returned for specific reviewer criteria. It contains the following fields:
  • UserId - the Artifact ID for a Relativity user.
  • Statistics - includes information about the extracted text size. It contains the following field:
    • TotalBytes - the total number of bytes of extracted text size for all of documents reviewed by the specified reviewer.

The request contains the following fields:

• criteria - represents the actions, users, and timeframe used when retrieving an aggregate of user actions per hour. It contains the following fields:
  • AuditActionIds - an array of identifiers for the audit actions performed on document.
  • UserIds - an array of Artifact IDs for Relativity users whose audit actions are included in the report.

    Note: If you pass an empty array, the report is computed for all the users in the workspace.

  • StartDate - the initial date for the reporting period.
  • EndDate - the final date for the reporting period.
  • TimeZone - a time zone URL.

The response contains the following fields:

• ReviewerStatistics - includes information returned for specific reviewer criteria. It contains the following fields:
  • UserId - the Artifact ID for a Relativity user.
  • Statistics - includes information about the hour buckets returned. It contains the following field:
    • HourBuckets - an array of counts returned for a user. It contains the following fields:
      • HourOfDay - the hour of day when that the user performed the audit actions. This field uses the 24-hour clock format.
      • ActionCount - the number of audit actions that the user performed within the hour.

The request contains the following fields:

• reviewerChoicesCriteria - represents the fields, users, and timeframe used when retrieving choices set in reviews. It contains the following fields:
  • FieldIds - an array of Artifact IDs for fields used to compute the choices selected by reviewers. You can retrieve statistics for single choice fields, multiple choice fields, and Yes/No fields.
  • StartDate - the initial date for the reporting period.
  • EndDate - the final date for the reporting period.
  • TimeZone - a time zone URL.
  • UserIdsToExcludeInReport - an array of Artifact IDs for users who choice selections must be excluded from the report.
  • UserIdsToIncludeInReport - an array of Artifact IDs for users who choice selections must be included in the report.

    Note: If you pass an empty array for the UserIdsToExcludeInReport or the UserIdsToIncludeInReport field, the report is computed for all the users in the workspace.

The response contains the following fields:

• ReviewerStatistics - includes information returned for specific reviewer criteria. It contains the following fields:
  • UserId - the Artifact ID for a Relativity user.
  • Statistics - includes information about the choices that are set by reviewers. It contains the following field:
    • ReviewedFieldChoices - an array of fields reviewed by a user. Each item in the array contains the following fields:
      • FieldId - the Artifact ID of the field in Relativity.
      • ReviewedChoices - an array of choices that a reviewer used for coding. Each choice contains the following information:
        • ChoiceId - the Artifact ID of the choice in Relativity.
        • Count - the number of times this choice was set on the field.
      • TotalChoicesUnset - an integer value indicating the number of choices on this field that weren't used by a reviewer for coding.
      • FieldType - an integer that Relativity uses to identify the type of a field. The FieldType enumeration contains the following values.

        Name	Value
        MultipleChoice	0
        SingleChoice	1
        YesOrNo	2

  • TotalDocsUpdated - an integer value indicating the total number of documents that the reviewer coded with a choice.
  • TotalChoicesUnset - an integer value indicating the total number of choices that weren't used by a reviewer for coding.

The request contains the following fields:

• reviewerStatsDataRequest - a request to generate a report based on the specified settings. It contains the following fields:
  • startDate - the initial date of the reporting period.
  • endDate - the final date of the reporting period.
  • timeZone - the time zone for the reviews included in the report. The time zone is specified as a UTC offset.
  • downTimeThreshold - the expected downtime (in seconds) between audit records. By default, this value is to 900 seconds (15 minutes).
  • nonAdmin - indicates whether the report is for non-admin users only.
  • additionalActions - indicates whether to include statistics for mass edits and propagation actions. Set this field to one of the following values:
    • None - include view and update actions.
    • Mass Edit - include view, update, and mass edit actions.
    • Propagation - include propagation actions.
    • Mass Edit and Propagation - include view, update, mass edit, and propagation actions.

The response contains the following fields:

Note: In the following descriptions, the term distinct indicates that an action occurred only once per document.

• FullName - the full name for the user.
• UserId - the Artifact ID for a Relativity user.
• TotalUsageTime - calculated as the difference between the time the reviewer first views or edits any document in the workspace, and the time the reviewer last views or edits any document in the workspace per session. A session is the timeframe during which the user is logged in to Relativity. All sessions for the selected date range are then totaled per reviewer.
• Views - the total number of documents that the reviewer looked at during the reporting period.
• DistinctViews - the number of unique documents that the reviewer looked at during the reporting period.
• Edits - the total number of editing or coding decisions made during the reporting period.
• DistinctEdits - the total number of documents edited, excluding repeated edits of the same document.
• EditsPerHour - the number of edits per hour based on the total usage time of the reviewer.
• EditsPerDay - the number of edits performed per day during the reporting period.
• DistinctEditsPerHour - the number of distinct edits per hour based on the total usage time of the reviewer.
• DistinctEditsPerDay - the number of distinct edits performed per day during the reporting period.
• DistinctMassEditsPerHour - the number of distinct mass edits per hour based on the total usage time of the reviewer.
• DistinctMassEditsPerDay - the number of distinct mass edits per day during the reporting period.
• MassEdits - the total number of document edits performed with the mass edit action.
• DistinctMassEdits - the total number of unique document edits performed with the mass edit action.
• MassEditsPerHour - the number of mass edits per hour based on the total usage time of the reviewer.
• MassEditsPerDay - the number of mass edits per day during the reporting period.
• Propagations - the total number of documents that were updated via propagation.
• DistinctPropagations - the total number of unique documents that were updated via propagation.
• DistinctMassPropagationsPerHour - the number of unique documents that had propagations applied per hour based on the total usage time of the reviewer.
• DistinctMassPropagationsPerDay - the number of unique documents that had propagations applied per day based during the reporting period.
• PropagationsPerHour - the number of propagations applied per hour based on the total usage time of the reviewer.
• PropagationsPerDay - the number of propagations applied per day based on the reporting period.

The request contains the following fields:

• workspaceId - the Artifact ID of the target workspace. To return the instance-level audit records, specify -1. This field is optional in the request. If a mismatch occurs between the ID in this field and the URL, then the ID in the URL is used in the request.
• request - represents a read operation on an audit record:
  • Id - the identifier for the audit record generated by Relativity.
  • Timestamp - the date and time that the audit record was created.

    Note: The request requires the Timestamp and Id fields to uniquely identify the audit record.

The response contains the following fields:

• ID - the ID of the audit record.
• TimeStamp - the date and time of the audit action.
• ArtifactName - the name of the audited artifact, such as the document control number.
• ActionName - the audit action name, such as create, update, query, or others.
• ActionID - the audit action ID.
• ObjectTypeName - the object type of the audited artifact, such as workspace or document.
• ObjectTypeID - the object type ID of the audited artifact.
• ExecutionTime - the length of time in milliseconds used to generate the audit details report.
• ArtifactID - the Artifact ID of the audited artifact.
• UserName - the username associated with the audit record.
• UserID - the Artifact ID of the user associated with the audit record.
• Details - the detailed audit action information.
• OldValues - the values of the fields that have been changed by the action.
• NewValues - the values of the fields that have been set by the action.
• Fields - the fields that have been changed by the action.
• WorkspaceId - the Artifact ID of the workspace associated with the audit record.
• WorkspaceName - the name of the workspace associated with the audit record.

The request contains the following fields:

• request - represents a query request for audit information. It 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:

    • Name - the user-friendly name for the field.
    • Guids - an array of GUIDs used to identify the field.
    • ArtifactID - the Artifact ID for field.
  • condition - the search criteria used in the query. For more information, Query conditions. This field is optional.
  • rowCondition - the filtering condition criteria for the result set. For more information, Query conditions. This field is optional.
  • executingViewId - reserved for future use.
• start - the values in the start and length fields both determine the page number being requested. For example, if you set length to 25 and start to record 17, Relativity interprets these setting as a request for the first page and returns audits 1-25. If you set start to 35, it returns the second page with audits 26-50.
• length - the number of items to return in the query result, beginning with index in the start field. See description for start field.

• TotalCount - the total number of objects in Relativity that meet the criteria of the query. For example, you may request 100 objects, but 115 objects satisfy the query. The ResultCount is 100, while the TotalCount is 115.
• Objects - an array of audit objects. The following fields are listed for each object:
  • ParentObject - reserved for future use.
  • Name - contains the Artifact ID of the parent object associated with object returned by the query operation.
  • FieldValues - an array containing FieldValuePair objects. It contains the following:
    • Value - the data assigned to a field.
    • Field - a field associated with a specific value. The Field object contains the following:
      • FieldCategory - indicates the specific functionality assigned to a field, such as stores descriptive text, acts as a relational field, represents grouping for batching, and others.
      • FieldType - the type of a Relativity field, such as fixed-length text, date, single object, or others.
      • ViewFieldID - a unique identifier used to reference a view field.
      • ArtifactID - a unique identifier for the field, which is represented as an integer.
      • Guids - an array of GUIDs used to identify the field.
      • Name - a user-friendly name for the field.
  • ArtifactID - a unique identifier for the object returned by the query.
  • Guids - an array of GUIDs used to identify the object returned by the query.
• IDWindow - reserved for future use.
• CurrentStartIndex - the index of the first artifact in the result set.
• ResultCount - the number of objects returned by the current query. Also, see the description of TotalCount field.
• ObjectType - reserved for future use.
• SampleDetails - reserved for future use.
• RankWindow - reserved for future use.
• RelationalField - name of relational field to expand query results to related objects.

• request - represents a query request for audit information. It contains the following fields:
  • objectType - the Audit object type identified by the Artifact Type ID on the Object Type. The values are different for each workspace and the instance-level object types. To programmatically return the Artifact Type ID, query the Relativity object types using the Services API.
    • artifactTypeID - an integer value used as an identifier for an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
  • 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:
    • Name - the user-friendly name for the field.
    • Guids - an array of GUIDs used to identify the field.
    • ArtifactID - the Artifact ID for field.
• condition - the search criteria used in the query. This field is optional.
• rowcondition - the filtering condition criteria for the result set. This field is optional.
• sorts - a collection of Sort objects. This field indicates whether the results are sorted in ascending or descending order, and identifies the field used to sort the results by name. This field is optional. See the Sort class in the kCura.Relativity.Client namespace.
• relationalField - name of relational field to expand query results to related objects. This field is optional.
• searchProviderCondition - specifies a search index other than the default keyword search index. This field is optional.
• includeIdWindow - reserved for future use.
• convertNumberFieldValuesToString - converts the response field values to strings. This field is optional.
• isAdHocQuery - reserved for future use.
• activeArtifactId - reserved for future use.
• queryHint - set a QueryHint field to optimize the view. For example, you can use the hashjoin setting with the value of true or false, or you can use the waitfor setting with a value, such as waitfor:5. This field is optional.
• executingViewId - reserved for future use.
• start - the index of the first artifact in the result set.
• length - the number of items to return in the query result, starting with index in the start field.

• cancel - represents a cancellation token. It contains the following fields:
  • RequestId - a GUID.
  • TicketId - a GUID.
• progress - represents a progress indicator. It contains the following fields:
  • RequestId - a GUID.
  • TicketId - a GUID.

Note: The use of progress indicators and cancellation tokens isn't supported, but you must include the cancel and progress fields in the request.

• TotalCount - the total number of objects in Relativity that meet the criteria of the query. For example, you may request 100 objects, but 115 objects satisfy the query. The ResultCount is 100, while the TotalCount is 115.
• Objects - an array of audit objects. The following fields are listed for each object:
  • ParentObject - reserved for future use.
  • Name - contains the Artifact ID of the parent object associated with object returned by the query operation.
  • FieldValues - an array containing FieldValuePair objects. It contains the following:
    • Value - the data assigned to a field.
    • Field - a field associated with a specific value. The Field object contains the following:
      • FieldCategory - indicates the specific functionality assigned to a field, such as stores descriptive text, acts as a relational field, represents grouping for batching, and others.
      • FieldType - the type of a Relativity field, such as fixed-length text, date, single object, or others.
      • ViewFieldID - a unique identifier used to reference a view field.
      • ArtifactID - a unique identifier for the field, which is represented as an integer.
      • Guids - an array of GUIDs used to identify the field.
      • Name - a user-friendly name for the field.
  • ArtifactID - a unique identifier for the object returned by the query.
  • Guids - an array of GUIDs used to identify the object returned by the query.
• IDWindow - reserved for future use.
• CurrentStartIndex - the index of the first artifact in the result set.
• ResultCount - the number of objects returned by the current query. Also, see the description of TotalCount field.
• ObjectType - reserved for future use.
• SampleDetails - reserved for future use.
• RankWindow - reserved for future use.
• RelationalField - name of relational field to expand query results to related objects.

• request - represents a query request for audit information. It contains the following fields:
  • objectType - the Audit object type identified by the Artifact Type ID on the Object Type. The values are different for each workspace and the instance-level object types. To programmatically return the Artifact Type ID, query the Relativity object types using the Services API.
    • artifactTypeID - an integer value used as an identifier for an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
  • 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:
    • Name - the user-friendly name for the field.
    • Guids - an array of GUIDs used to identify the field.
    • ArtifactID - the Artifact ID for field.
• condition - the search criteria used in the query. This field is optional.
• rowcondition - the filtering condition criteria for the result set. This field is optional.
• sorts - a collection of Sort objects. This field indicates whether the results are sorted in ascending or descending order, and identifies the field used to sort the results by name. This field is optional. See the Sort class in the kCura.Relativity.Client namespace.
• relationalField - name of relational field to expand query results to related objects. This field is optional.
• searchProviderCondition - specifies a search index other than the default keyword search index. This field is optional.
• includeIdWindow - reserved for future use.
• convertNumberFieldValuesToString - converts the response field values to strings. This field is optional.
• isAdHocQuery - reserved for future use.
• activeArtifactId - reserved for future use.
• queryHint - set a QueryHint field to optimize the view. For example, you can use the hashjoin setting with the value of true or false, or you can use the waitfor setting with a value, such as waitfor:5. This field is optional.
• executingViewId - reserved for future use.
• start - the index of the first artifact in the result set.
• length - the number of items to return in the query result, starting with index in the start field.

• auditQueryOptions - additional query options:
  • ReturnRawDetails - a Boolean value indicating whether the Details field should contain an escaped JSON string instead of HTML. Set this field to true if you want to perform further analysis on the audit data. Otherwise, the data is returned as HTML for display on the Audit tab in the Relativity UI. For more information, see Audit in the Relativity Documentation site.

• TotalCount - the total number of objects in Relativity that meet the criteria of the query. For example, you may request 100 objects, but 115 objects satisfy the query. The ResultCount is 100, while the TotalCount is 115.
• Objects - an array of audit objects. The following fields are listed for each object:
  • ParentObject - reserved for future use.
  • Name - contains the Artifact ID of the parent object associated with object returned by the query operation.
  • FieldValues - an array containing FieldValuePair objects. It contains the following:
    • Value - the data assigned to a field.
    • Field - a field associated with a specific value. The Field object contains the following:
      • FieldCategory - indicates the specific functionality assigned to a field, such as stores descriptive text, acts as a relational field, represents grouping for batching, and others.
      • FieldType - the type of a Relativity field, such as fixed-length text, date, single object, or others.
      • ViewFieldID - a unique identifier used to reference a view field.
      • ArtifactID - a unique identifier for the field, which is represented as an integer.
      • Guids - an array of GUIDs used to identify the field.
      • Name - a user-friendly name for the field.
  • ArtifactID - a unique identifier for the object returned by the query.
  • Guids - an array of GUIDs used to identify the object returned by the query.
• IDWindow - reserved for future use.
• CurrentStartIndex - the index of the first artifact in the result set.
• ResultCount - the number of objects returned by the current query. Also, see the description of TotalCount field.
• ObjectType - reserved for future use.
• SampleDetails - reserved for future use.
• RankWindow - reserved for future use.
• RelationalField - name of relational field to expand query results to related objects.

• request - represents a query request for audit information. It contains the following fields:
  • objectType - the Audit object type identified by the Artifact Type ID on the Object Type. The values are different for each workspace and the instance-level object types. To programmatically return the Artifact Type ID, query the Relativity object types using the Services API.
    • artifactTypeID - an integer value used as an identifier for an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
  • 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:
    • Name - the user-friendly name for the field.
    • Guids - an array of GUIDs used to identify the field.
    • ArtifactID - the Artifact ID for field.
• condition - the search criteria used in the query. This field is optional.
• rowcondition - the filtering condition criteria for the result set. This field is optional.
• sorts - a collection of Sort objects. This field indicates whether the results are sorted in ascending or descending order, and identifies the field used to sort the results by name. This field is optional. See the Sort class in the kCura.Relativity.Client namespace.
• relationalField - name of relational field to expand query results to related objects. This field is optional.
• searchProviderCondition - specifies a search index other than the default keyword search index. This field is optional.
• includeIdWindow - reserved for future use.
• convertNumberFieldValuesToString - converts the response field values to strings. This field is optional.
• isAdHocQuery - reserved for future use.
• activeArtifactId - reserved for future use.
• queryHint - set a QueryHint field to optimize the view. For example, you can use the hashjoin setting with the value of true or false, or you can use the waitfor setting with a value, such as waitfor:5. This field is optional.
• executingViewId - reserved for future use.
• start - the index of the first artifact in the result set.
• length - the number of items to return in the query result, starting with index in the start field.

• cancel - represents a cancellation token. It contains the following fields:
  • RequestId - a GUID.
  • TicketId - a GUID.
• progress - represents a progress indicator. It contains the following fields:
  • RequestId - a GUID.
  • TicketId - a GUID.

Note: The use of progress indicators and cancellation tokens isn't supported, but you must include the cancel and progress fields in the request.

• TotalCount - the total number of objects in Relativity that meet the criteria of the query. For example, you may request 100 objects, but 115 objects satisfy the query. The ResultCount is 100, while the TotalCount is 115.
• Objects - an array of audit objects. The following fields are listed for each object:
  • ArtifactID - the Artifact ID of the object.
  • Values - an array of values for the fields specified in the request.
• IDWindow - reserved for future use.
• CurrentStartIndex - the index of the first artifact in the result set.
• ResultCount - the number of objects returned by the current query. Also, see the description of TotalCount field.
• ObjectType - reserved for future use.
• SampleDetails - reserved for future use.
• RankWindow - reserved for future use.
• RelationalField - name of relational field to expand query results to related objects.
• Fields - an array of the fields corresponding to the values.
  • FieldCategory - indicates the specific functionality assigned to a field, such as stores descriptive text, acts as a relational field, represents grouping for batching, and others.
  • FieldType - the type of a Relativity field, such as fixed-length text, date, single object, or others.
  • ViewFieldID - a unique identifier used to reference a view field.
  • ArtifactID - a unique identifier for the field, which is represented as an integer.
  • Guids - an array of GUIDs used to identify the field.
  • Name - a user-friendly name for the field.