Enterprise Vault™ Compliance Accelerator Reviewer's Guide

Last Published:
Product(s): Enterprise Vault (15.0)
  1. Introducing Compliance Accelerator
    1.  
      Key features of Compliance Accelerator
    2.  
      About the Compliance Accelerator components
    3.  
      The Compliance Accelerator process
    4. Product documentation
      1.  
        White papers on the Veritas Support website
      2.  
        "How To" articles on the Veritas Support website
  2. Introducing Veritas Surveillance
    1.  
      About Veritas Surveillance
    2.  
      Routine operations executed with Veritas Surveillance
    3.  
      About Veritas Surveillance system security
    4.  
      Feature comparison: Compliance Accelerator desktop client Vs Veritas Surveillance web client
  3. Creating and viewing reports
    1.  
      About the Compliance Accelerator reports
    2.  
      Accessing data through the Microsoft SQL Server Reporting Services (SSRS)
    3. Enhanced reporting
      1.  
        Configuring a reporting endpoint
      2.  
        Authentication
      3. Departments API
        1.  
          Departments - List
      4. Roles API
        1.  
          Roles - List
        2.  
          Roles - List by filters
      5. Users API
        1.  
          Users - List
      6. UserRoles API
        1.  
          UserRoles - List by filters
      7. ItemMetrics API
        1.  
          ItemMetrics - List
        2.  
          ItemMetrics - List by filter
      8. Evidence of Review by Department API
        1.  
          EvidenceOfReviewByDept - List by filter
      9. Evidence of Review by User API
        1.  
          EvidenceOfReviewByUser - List by filter
      10.  
        Supported OData query options
      11.  
        Supported reporting endpoint API filters and their values
      12.  
        Responses
    4. Accessing reports through the OData web service
      1.  
        Available Compliance Accelerator datasets
      2.  
        Accessing the Compliance Accelerator datasets
      3.  
        Using the OData service with Microsoft Excel
      4.  
        Using the OData service with Microsoft SQL Server Reporting Services (SSRS)
      5.  
        Troubleshooting OData errors
    5.  
      Configuring a Power BI template for reporting

UserRoles - List by filters

POST https://<Reporting endpoint Base URL>/odata/userroles

Request body

Specify the following filters to obtain refined and selective results from this report.

Note:

Either Departments or Users is a mandatory parameter. The Scope is an optional parameter.

Name

Type

Description

Departments

Mandatory (if the Users parameter is not provided)

Optional (if the Users parameter is provided)

Specifies IDs of the departments to which users and their roles belongs to.

Limitations:

The Users roles API can pass a maximum of 100 Departments IDs as input.

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

Scopes

Optional

Specifies the scope of the users roles. Possible values are: 160 for application-level roles and 161 for department-level roles.

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

Users

Mandatory (if the Departments parameter is not provided)

Optional (if the Departments parameter is provided)

Specifies IDs of the users.

Limitations

The Users roles API can pass a maximum of 100 User IDs as input.

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

Scenario 1

To get the item counts only for Users when the Users are mentioned, but the Departments and the Scopes are not mentioned.

Sample request

POST https://<Reporting endpoint Base URL>/odata/Userroles

{

"Departments": [],

"Scopes" :[]

"Users" :[3821]

}

Scenario 2

To get the item counts only for users when Departments are mentioned, but the Scopes and Users are mentioned.

Sample request

POST https://<Reporting endpoint Base URL>/odata/Userroles

{

"Departments": [23],

"Scopes" :[]

"Users" :[]

}

Scenario 3

To get the item counts only for users when Departments and Scopes are mentioned, but Users are not mentioned.

Sample request

POST https://<Reporting endpoint Base URL>/odata/Userroles

{

"Departments": [23],

"Scopes" :[161]

"Users" :[]

}

Scenario 4

To get the item counts only for users when Departments are not mentioned, but the Scopes and Users are mentioned.

Sample request

POST https://<Reporting endpoint Base URL>/odata/Userroles

{

"Departments": []

"Scopes" :[160]

"Users" :[3821]

}

Scenario 5

To get the item counts only for users when the Departments, Scopes, and Users are mentioned.

Sample request

POST https://<Reporting endpoint Base URL>/odata/Userroles

{

"Departments": [23],

"Scopes" :[160,161]

"Users" :[55,67]

}

Sample response

(For scenario 1 to 5) Status code: 200 OK

Scenario 6

Invalid Inputs. Either the Department or the User parameter must be specified as input.

Sample request

POST https://<Reporting endpoint Base URL>/odata/Userroles

{

"Departments": [],

"Scopes" :[160]

"Users" :[]

}

Sample response

Status code: 400 Bad Request Error Code: InvalidOdataQuery

Supported OData Filters

See Supported OData query options.

Responses

See Responses.