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

IntegrationsHipchatApi.md

Latest commit

 

History

History
198 lines (149 loc) · 9.95 KB

IntegrationsHipchatApi.md

File metadata and controls

198 lines (149 loc) · 9.95 KB

IntegrationsHipchatApi

All URIs are relative to http://localhost/

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

create

IntegrationHipchat create(externalAccountIds, name, room, token, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, sendUpdates, sendWhenSuppressed, signatureIds, statuses)

Create a Hipchat Integration

Example

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


IntegrationsHipchatApi apiInstance = new IntegrationsHipchatApi();
List<Integer> externalAccountIds = Arrays.asList(56); // List<Integer> | External accounts for integration
String name = "name_example"; // String | Name of the integration
String room = "room_example"; // String | The Hipchat room
String token = "token_example"; // String | The Hipchat token
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 {
    IntegrationHipchat result = apiInstance.create(externalAccountIds, name, room, token, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, sendUpdates, sendWhenSuppressed, signatureIds, statuses);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsHipchatApi#create");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountIds List<Integer> External accounts for integration
name String Name of the integration
room String The Hipchat room
token String The Hipchat token
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

IntegrationHipchat

Authorization

No authorization required

HTTP request headers

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

show

IntegrationHipchat show(integrationId, include)

Show a single Hipchat Integration

Example

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


IntegrationsHipchatApi apiInstance = new IntegrationsHipchatApi();
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 {
    IntegrationHipchat result = apiInstance.show(integrationId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsHipchatApi#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

IntegrationHipchat

Authorization

No authorization required

HTTP request headers

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

update

IntegrationHipchat update(integrationId, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, externalAccountIds, name, room, sendUpdates, sendWhenSuppressed, signatureIds, statuses, token)

Update a Hipchat Integration

Example

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


IntegrationsHipchatApi apiInstance = new IntegrationsHipchatApi();
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 name = "name_example"; // String | Name of the integration
String room = "room_example"; // String | The Hipchat room
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 token = "token_example"; // String | The Hipchat token
try {
    IntegrationHipchat result = apiInstance.update(integrationId, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, externalAccountIds, name, room, sendUpdates, sendWhenSuppressed, signatureIds, statuses, token);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsHipchatApi#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]
name String Name of the integration [optional]
room String The Hipchat room [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]
token String The Hipchat token [optional]

Return type

IntegrationHipchat

Authorization

No authorization required

HTTP request headers

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