AuditLogsApi.md

AuditLogsApi

All URIs are relative to http://localhost/

Method	HTTP request	Description
list	PUT api/v2/audit_logs.json_api	Get a list of Audit Logs
show	GET api/v2/audit_logs/{id}.json_api	Show a single Audit Log

list

PaginatedCollection list(include, filter, page)

Get a list of Audit Logs

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.AuditLogsApi;


AuditLogsApi apiInstance = new AuditLogsApi();
String include = "include_example"; // String | Related objects that can be included in the response:  organization, user See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, item_id, item_type] Matching Searchable Attribute: [item_type]  Sortable Attribute: [id] Searchable Associations: [user, organization] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.
String page = "{:number=>1,+:size=>20}"; // String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
try {
    PaginatedCollection result = apiInstance.list(include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuditLogsApi#list");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
include	String	Related objects that can be included in the response: organization, user See Including Objects for more information.	[optional]
filter	Map<String, String>	Filter Params for Searching. Equality Searchable Attributes: [id, item_id, item_type] Matching Searchable Attribute: [item_type] Sortable Attribute: [id] Searchable Associations: [user, organization] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.	[optional]
page	String	Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page.	[optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

No authorization required

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json

show

AuditLog show(id, include)

Show a single Audit Log

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.AuditLogsApi;


AuditLogsApi apiInstance = new AuditLogsApi();
Integer id = 56; // Integer | Audit Log ID
String include = "include_example"; // String | Related objects that can be included in the response:  organization, user See Including Objects for more information.
try {
    AuditLog result = apiInstance.show(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuditLogsApi#show");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer	Audit Log ID
include	String	Related objects that can be included in the response: organization, user See Including Objects for more information.	[optional]

Return type

AuditLog

Authorization

No authorization required

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json