Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

ScanIntervalsApi.md

Latest commit

 

History

History
258 lines (179 loc) · 8.29 KB

ScanIntervalsApi.md

File metadata and controls

258 lines (179 loc) · 8.29 KB

ScanIntervalsApi

All URIs are relative to http://localhost/

Method HTTP request Description
create POST api/v2/scan_intervals.json_api Create a(n) Scan Interval
delete DELETE api/v2/scan_intervals/{id}.json_api Delete a(n) Scan Interval
listForExternalAccount GET api/v2/external_accounts/{external_account_id}/scan_intervals.json_api Get a list of Scan Intervals
show GET api/v2/scan_intervals/{id}.json_api Show a single Scan Interval
update PATCH api/v2/scan_intervals/{id}.json_api Update a(n) Scan Interval

create

ScanInterval create(externalAccountId, interval, serviceId, include)

Create a(n) Scan Interval

Example

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


ScanIntervalsApi apiInstance = new ScanIntervalsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account this scan interval is for
Integer interval = 56; // Integer | The interval, in minutes, this service will be scanned
Integer serviceId = 56; // Integer | The service ID for the scan interval
String include = "include_example"; // String | Related objects that can be included in the response:  external_account, service See Including Objects for more information.
try {
    ScanInterval result = apiInstance.create(externalAccountId, interval, serviceId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ScanIntervalsApi#create");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account this scan interval is for
interval Integer The interval, in minutes, this service will be scanned
serviceId Integer The service ID for the scan interval
include String Related objects that can be included in the response: external_account, service See Including Objects for more information. [optional]

Return type

ScanInterval

Authorization

No authorization required

HTTP request headers

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

delete

Meta delete(id)

Delete a(n) Scan Interval

Example

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


ScanIntervalsApi apiInstance = new ScanIntervalsApi();
Integer id = 56; // Integer | Scan Interval ID
try {
    Meta result = apiInstance.delete(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ScanIntervalsApi#delete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer Scan Interval ID

Return type

Meta

Authorization

No authorization required

HTTP request headers

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

listForExternalAccount

PaginatedCollection listForExternalAccount(externalAccountId, include, page)

Get a list of Scan Intervals

Example

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


ScanIntervalsApi apiInstance = new ScanIntervalsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account to retrieve
String include = "include_example"; // String | Related objects that can be included in the response:  external_account, service See Including Objects 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.listForExternalAccount(externalAccountId, include, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ScanIntervalsApi#listForExternalAccount");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account to retrieve
include String Related objects that can be included in the response: external_account, service See Including Objects 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

ScanInterval show(id, include)

Show a single Scan Interval

Example

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


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

Parameters

Name Type Description Notes
id Integer Scan Interval ID
include String Related objects that can be included in the response: external_account, service See Including Objects for more information. [optional]

Return type

ScanInterval

Authorization

No authorization required

HTTP request headers

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

update

ScanInterval update(id, include, externalAccountId, interval, serviceId)

Update a(n) Scan Interval

Example

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


ScanIntervalsApi apiInstance = new ScanIntervalsApi();
Integer id = 56; // Integer | Scan Interval ID
String include = "include_example"; // String | Related objects that can be included in the response:  external_account, service See Including Objects for more information.
Integer externalAccountId = 56; // Integer | The ID of the external account this scan interval is for
Integer interval = 56; // Integer | The interval, in minutes, this service will be scanned
Integer serviceId = 56; // Integer | The service ID for the scan interval
try {
    ScanInterval result = apiInstance.update(id, include, externalAccountId, interval, serviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ScanIntervalsApi#update");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer Scan Interval ID
include String Related objects that can be included in the response: external_account, service See Including Objects for more information. [optional]
externalAccountId Integer The ID of the external account this scan interval is for [optional]
interval Integer The interval, in minutes, this service will be scanned [optional]
serviceId Integer The service ID for the scan interval [optional]

Return type

ScanInterval

Authorization

No authorization required

HTTP request headers

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