Enterprise Vault™ Compliance Accelerator Reviewer's Guide

Last Published:
Product(s): Enterprise Vault (15.1)

EvidenceOfReviewByDept - List by filter

POST https://<Reporting endpoint base URL>/odata/EvidenceOfReviewByDept

Sample requests

POST https://<Reporting endpoint base URL>/odata/EvidenceOfReviewByDept

EvidenceOfReviewByDept - URL Parameter/Filters

The following filters can be used with the EvidenceOfReviewByDept API when invoked using the POST method. The system uses the AND operator between the filters to return the result based on the specified filters.

Name

Type

Description

StartDate

Mandatory

StartDate is the date on which items are captured or ingested in Compliance Accelerator is recorded as the CaptureDate for that item.

This filter specifies the start date for returning count of items whose CaptureDate is greater than or equal to this start date.

Date format: YYYY-MM-DD

Data Type: JSON array of integers 'id'(identifier fields) that is StartDate.

EndDate

Mandatory

This filter specifies the end date for returning count of items whose CaptureDate is greater than or equal to this date.

Date format: YYYY-MM-DD

Data Type: JSON array of integers 'id'(identifier fields) that is EndDate.

MessageType

Mandatory

Specifies the type of captured items and returns item counts for items that have the specified message type.

Data Type: Integer 'id' (identifier fields) that is MessageType ID.

Departments

Mandatory

Specifies the departments to which the captured item belongs and returns item counts for items within that department.

Data Type: JSON string containing integer IDs (identifier field) that is department IDs.

Limitation: As an input, this API can pass maximum of 1000 Departments IDs.

MessageDirection

Mandatory

Specifies whether the item was sent/received from within the organization or from an external source and returns item counts for items that have the specified message direction.

Data Type: Integer id (identifier field) that is MessageDirection ID

Scenario 1

To get the item counts for Department IDs 5 and 6, between StartDate 2023-01-01 and EndDate 2024-01-01 and having MessageType as 7, and MessageDirection as 1.

Sample response

Status code: 200 OK

Supported OData filters

See Supported OData query options.

Supported reporting endpoint API filters and their values

See Supported reporting endpoint API filters and their values.

Responses

See Responses.