Audit Web Services
Overview
Universal Controller supports the following RESTful-based web service for Audits.
Users with the ops_admin role or ops_audit_view role can use Audit Web Services for all Audit records.
If Audit Owner Read Permitted system property = true, users without either the ops_admin role or the ops_audit_view role can use Audit Web Services to view their own audits.
Formatting specifications for the web service, including details about parameter requirements, are provided.
List Audit Records
Description | |
URI | http://host_name/uc/resources/audit/list |
Description | Retrieve the audit details using a specific filter. |
HTTP Method |
POST |
Example URI |
http://localhost:8080/uc/resources/audit/list |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | application/xml, application/json |
List Audit Records: XML and JSON Examples
List Audit Records: Example Request
XML Request |
JSON Request |
---|---|
|
|
List Audit Records: Request Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
auditType |
Audit Type | Audit type to filter the data. |
Valid values: One of the following (not case sensitive):
|
N | |
source |
Source | Audit source type |
Valid values: One of the following (not case sensitive):
|
N | |
updatedTime |
n/a | If updatedTimeType = Offset; -offset period. |
Valid values:
Default is d. |
Y (if updatedTimeType is Offset , Since , or Older Than .) |
|
|
n/a | Type of updateTime . |
Valid values:
|
N | |
createdBy |
Created By |
Name of the person created the record. |
N | ||
status |
Status |
Status of the record |
N | ||
tableRecordName |
Table Record Name | table record name | N | ||
tableName |
Table Name | table name | N | ||
tableKey |
Table Key | table key | N | ||
includeChildAudits |
n/a | include child audits |
boolean property Valid values: true, false, 1, 0 |
N |
List Audit Records: Example Response
XML Response |
JSON Response |
---|---|
|
|
List Audit Records: Example Response with Child Audits
XML Response with Child Audits |
JSON Response with Child Audits |
---|---|
|
|