Skip to content

Latest commit

 

History

History
206 lines (158 loc) · 5.84 KB

SavedSearchesApi.md

File metadata and controls

206 lines (158 loc) · 5.84 KB
Raw

LogSentinel.Client.Api.SavedSearchesApi

All URIs are relative to https://api.logsentinel.com

Method HTTP request Description
CreateSavedSearch POST /api/search/saved Creates saved search
GetSavedSearchIds GET /api/search/saved/fetch Fetches saved search ids of all users of an organization
PerformSavedSearch GET /api/search/saved Calls saved search by its id

CreateSavedSearch

List CreateSavedSearch (long? end, string name, int? page, int? pageSize, string query, long? start)

Creates saved search

Example

using System;
using System.Diagnostics;
using LogSentinel.Client.Api;
using LogSentinel.Client.Client;
using LogSentinel.Client.Model;

namespace Example
{
    public class CreateSavedSearchExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SavedSearchesApi();
            var end = 789;  // long? | end
            var name = name_example;  // string | name
            var page = 56;  // int? | page
            var pageSize = 56;  // int? | pageSize
            var query = query_example;  // string | query
            var start = 789;  // long? | start

            try
            {
                // Creates saved search
                List<SavedSearch> result = apiInstance.CreateSavedSearch(end, name, page, pageSize, query, start);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SavedSearchesApi.CreateSavedSearch: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
end long? end
name string name
page int? page
pageSize int? pageSize
query string query
start long? start

Return type

List

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json, /
  • Accept: /, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSavedSearchIds

List GetSavedSearchIds ()

Fetches saved search ids of all users of an organization

Example

using System;
using System.Diagnostics;
using LogSentinel.Client.Api;
using LogSentinel.Client.Client;
using LogSentinel.Client.Model;

namespace Example
{
    public class GetSavedSearchIdsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SavedSearchesApi();

            try
            {
                // Fetches saved search ids of all users of an organization
                List<SavedSearch> result = apiInstance.GetSavedSearchIds();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SavedSearchesApi.GetSavedSearchIds: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

basicAuth

HTTP request headers

  • Content-Type: /
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PerformSavedSearch

List PerformSavedSearch (string savedSearchId)

Calls saved search by its id

Example

using System;
using System.Diagnostics;
using LogSentinel.Client.Api;
using LogSentinel.Client.Client;
using LogSentinel.Client.Model;

namespace Example
{
    public class PerformSavedSearchExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SavedSearchesApi();
            var savedSearchId = savedSearchId_example;  // string | savedSearchId

            try
            {
                // Calls saved search by its id
                List<AuditLogEntry> result = apiInstance.PerformSavedSearch(savedSearchId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SavedSearchesApi.PerformSavedSearch: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
savedSearchId string savedSearchId

Return type

List

Authorization

basicAuth

HTTP request headers

  • Content-Type: /
  • Accept: /, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]