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

CustomSignatureResultsApi.md

Latest commit

 

History

History
214 lines (151 loc) · 9.46 KB

CustomSignatureResultsApi.md

File metadata and controls

214 lines (151 loc) · 9.46 KB

CustomSignatureResultsApi

All URIs are relative to http://localhost/

Method HTTP request Description
create POST api/v2/custom_signature_results.json_api Create a(n) Custom Signature Result
list PUT api/v2/custom_signature_results.json_api Get a list of Custom Signature Results
listAlerts GET api/v2/custom_signature_results/{custom_signature_result_id}/alerts.json_api Returns the Alerts for a given Custom Signature Result
show GET api/v2/custom_signature_results/{id}.json_api Show a single Custom Signature Result

create

CustomSignatureResult create(code, customSignatureDefinitionId, externalAccountId, language, include, region, regionId)

Create a(n) Custom Signature Result

Example

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


CustomSignatureResultsApi apiInstance = new CustomSignatureResultsApi();
String code = "code_example"; // String | The code for this definition
Integer customSignatureDefinitionId = 56; // Integer | ID of the custom signature definition this result belongs to
Integer externalAccountId = 56; // Integer | ID of the external account the code should run for
String language = "language_example"; // String | The language of the definition. Valid values are ruby, javascript
String include = "include_example"; // String | Related objects that can be included in the response:  external_account, region, definition See Including Objects for more information.
String region = "region_example"; // String | Code of the region the result code should run for. Ex: us-east-1. This can be sent instead of region_id
Integer regionId = 56; // Integer | ID of the region the code should run for.  Required if region is not supplied.
try {
    CustomSignatureResult result = apiInstance.create(code, customSignatureDefinitionId, externalAccountId, language, include, region, regionId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomSignatureResultsApi#create");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
code String The code for this definition
customSignatureDefinitionId Integer ID of the custom signature definition this result belongs to
externalAccountId Integer ID of the external account the code should run for
language String The language of the definition. Valid values are ruby, javascript [enum: ruby, javascript]
include String Related objects that can be included in the response: external_account, region, definition See Including Objects for more information. [optional]
region String Code of the region the result code should run for. Ex: us-east-1. This can be sent instead of region_id [optional]
regionId Integer ID of the region the code should run for. Required if region is not supplied. [optional]

Return type

CustomSignatureResult

Authorization

No authorization required

HTTP request headers

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

list

PaginatedCollection list(include, filter, page)

Get a list of Custom Signature Results

Example

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


CustomSignatureResultsApi apiInstance = new CustomSignatureResultsApi();
String include = "include_example"; // String | Related objects that can be included in the response:  external_account, region, definition See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, language, status]   Sortable Attribute: [id] Searchable Associations: [definition, region, external_account] 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 CustomSignatureResultsApi#list");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
include String Related objects that can be included in the response: external_account, region, definition See Including Objects for more information. [optional]
filter Map<String, String> Filter Params for Searching. Equality Searchable Attributes: [id, language, status] Sortable Attribute: [id] Searchable Associations: [definition, region, external_account] 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

listAlerts

PaginatedCollection listAlerts(customSignatureResultId, include, page)

Returns the Alerts for a given Custom Signature Result

This format is slightly different than the standard alert format. A successful call to this API returns a list of alerts for the custom signature result identified by the custom_signature_result_id parameter.

Example

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


CustomSignatureResultsApi apiInstance = new CustomSignatureResultsApi();
Integer customSignatureResultId = 56; // Integer | Custom Signature Result ID
String include = "include_example"; // String | Related objects that can be included in the response:  external_account, region, custom_signature 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.listAlerts(customSignatureResultId, include, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomSignatureResultsApi#listAlerts");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
customSignatureResultId Integer Custom Signature Result ID
include String Related objects that can be included in the response: external_account, region, custom_signature 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

CustomSignatureResult show(id, include)

Show a single Custom Signature Result

Example

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


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

Parameters

Name Type Description Notes
id Integer Custom Signature Result ID
include String Related objects that can be included in the response: external_account, region, definition See Including Objects for more information. [optional]

Return type

CustomSignatureResult

Authorization

No authorization required

HTTP request headers

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