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

Latest commit

 

History

History
210 lines (162 loc) · 11.2 KB

File metadata and controls

210 lines (162 loc) · 11.2 KB

IntegrationsJiraApi

All URIs are relative to http://localhost/

Method HTTP request Description
create POST api/v2/integrations/jira.json_api Create a JIRA Integration
show GET api/v2/integrations/{integration_id}/jira.json_api Show a single Jira Integration
update PATCH api/v2/integrations/{integration_id}/jira.json_api Update a JIRA Integration

create

IntegrationJira create(externalAccountIds, issueType, name, password, projectKey, url, username, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, sendUpdates, sendWhenSuppressed, signatureIds, statuses)

Create a JIRA Integration

Example

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


IntegrationsJiraApi apiInstance = new IntegrationsJiraApi();
List<Integer> externalAccountIds = Arrays.asList(56); // List<Integer> | External accounts for integration
String issueType = "issueType_example"; // String | The Issue Type for ESP Alerts
String name = "name_example"; // String | Name of the integration
String password = "password_example"; // String | A password to access the JIRA project
String projectKey = "projectKey_example"; // String | The designated Key for your Jira project
String url = "url_example"; // String | The host and port portion of the Jira REST API URL
String username = "username_example"; // String | A username to access the Jira project
String include = "include_example"; // String | Related objects that can be included in the response:  integration See Including Objects for more information.
Boolean allHighRisk = true; // Boolean | Send all high risk alerts
Boolean allLowRisk = true; // Boolean | Send all low risk alerts
Boolean allMediumRisk = true; // Boolean | Send all medium risk alerts
List<Integer> customSignatureIds = Arrays.asList(56); // List<Integer> | Custom signatures for integration
Boolean sendUpdates = true; // Boolean | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons.
Boolean sendWhenSuppressed = true; // Boolean | Send notifications for suppressed alerts
List<Integer> signatureIds = Arrays.asList(56); // List<Integer> | Signatures for integration
List<String> statuses = Arrays.asList("statuses_example"); // List<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info
try {
    IntegrationJira result = apiInstance.create(externalAccountIds, issueType, name, password, projectKey, url, username, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, sendUpdates, sendWhenSuppressed, signatureIds, statuses);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsJiraApi#create");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountIds List<Integer> External accounts for integration
issueType String The Issue Type for ESP Alerts
name String Name of the integration
password String A password to access the JIRA project
projectKey String The designated Key for your Jira project
url String The host and port portion of the Jira REST API URL
username String A username to access the Jira project
include String Related objects that can be included in the response: integration See Including Objects for more information. [optional]
allHighRisk Boolean Send all high risk alerts [optional]
allLowRisk Boolean Send all low risk alerts [optional]
allMediumRisk Boolean Send all medium risk alerts [optional]
customSignatureIds List<Integer> Custom signatures for integration [optional]
sendUpdates Boolean This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons. [optional]
sendWhenSuppressed Boolean Send notifications for suppressed alerts [optional]
signatureIds List<Integer> Signatures for integration [optional]
statuses List<String> Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info [optional]

Return type

IntegrationJira

Authorization

No authorization required

HTTP request headers

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

show

IntegrationJira show(integrationId, include)

Show a single Jira Integration

Password is not returned.

Example

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


IntegrationsJiraApi apiInstance = new IntegrationsJiraApi();
Integer integrationId = 56; // Integer | The ID of the integration
String include = "include_example"; // String | Related objects that can be included in the response:  integration See Including Objects for more information.
try {
    IntegrationJira result = apiInstance.show(integrationId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsJiraApi#show");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
integrationId Integer The ID of the integration
include String Related objects that can be included in the response: integration See Including Objects for more information. [optional]

Return type

IntegrationJira

Authorization

No authorization required

HTTP request headers

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

update

IntegrationJira update(integrationId, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, externalAccountIds, issueType, name, password, projectKey, sendUpdates, sendWhenSuppressed, signatureIds, statuses, url, username)

Update a JIRA Integration

Example

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


IntegrationsJiraApi apiInstance = new IntegrationsJiraApi();
Integer integrationId = 56; // Integer | The ID of the integration
String include = "include_example"; // String | Related objects that can be included in the response:  integration See Including Objects for more information.
Boolean allHighRisk = true; // Boolean | Send all high risk alerts
Boolean allLowRisk = true; // Boolean | Send all low risk alerts
Boolean allMediumRisk = true; // Boolean | Send all medium risk alerts
List<Integer> customSignatureIds = Arrays.asList(56); // List<Integer> | Custom signatures for integration
List<Integer> externalAccountIds = Arrays.asList(56); // List<Integer> | External accounts for integration
String issueType = "issueType_example"; // String | The Issue Type for ESP Alerts
String name = "name_example"; // String | Name of the integration
String password = "password_example"; // String | A password to access the JIRA project
String projectKey = "projectKey_example"; // String | The designated Key for your Jira project
Boolean sendUpdates = true; // Boolean | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons.
Boolean sendWhenSuppressed = true; // Boolean | Send notifications for suppressed alerts
List<Integer> signatureIds = Arrays.asList(56); // List<Integer> | Signatures for integration
List<String> statuses = Arrays.asList("statuses_example"); // List<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info
String url = "url_example"; // String | The host and port portion of the Jira REST API URL
String username = "username_example"; // String | A username to access the Jira project
try {
    IntegrationJira result = apiInstance.update(integrationId, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, externalAccountIds, issueType, name, password, projectKey, sendUpdates, sendWhenSuppressed, signatureIds, statuses, url, username);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsJiraApi#update");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
integrationId Integer The ID of the integration
include String Related objects that can be included in the response: integration See Including Objects for more information. [optional]
allHighRisk Boolean Send all high risk alerts [optional]
allLowRisk Boolean Send all low risk alerts [optional]
allMediumRisk Boolean Send all medium risk alerts [optional]
customSignatureIds List<Integer> Custom signatures for integration [optional]
externalAccountIds List<Integer> External accounts for integration [optional]
issueType String The Issue Type for ESP Alerts [optional]
name String Name of the integration [optional]
password String A password to access the JIRA project [optional]
projectKey String The designated Key for your Jira project [optional]
sendUpdates Boolean This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons. [optional]
sendWhenSuppressed Boolean Send notifications for suppressed alerts [optional]
signatureIds List<Integer> Signatures for integration [optional]
statuses List<String> Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info [optional]
url String The host and port portion of the Jira REST API URL [optional]
username String A username to access the Jira project [optional]

Return type

IntegrationJira

Authorization

No authorization required

HTTP request headers

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