public interface AlertsIncidentsAndEventsApi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`retrofit2.Call<Void>`	`createDeploymentEvent(DeploymentEvent body)`	Create deployment event Create an deployment event for a System Profile.
`retrofit2.Call<DeploymentEvent>`	`getDeploymentEvent(String eventid)`	Get deployment event record Get the JSON representation of a deployment event.
`retrofit2.Call<de.tsystems.mms.apm.performancesignature.dynatrace.model.Alert>`	`getIncident(String alertid)`	Get Alert record Get the JSON representation of an alert (incident).
`retrofit2.Call<Alerts>`	`getIncidents(String systemprofile, String incidentrule, String state, String from, String to)`	List Alerts Get a list of all alerts (incidents) that match the filter settings.
`retrofit2.Call<Void>`	`updateDeploymentEvent(String eventid, EventUpdate body)`	Update deployment event record Several attributes of a deployment event can be modified by updating it.

Method Detail

createDeploymentEvent
```
@Headers("Content-Type:application/json")
@POST("api/v2/events/Deployment")
retrofit2.Call<Void> createDeploymentEvent(@Body
                                           DeploymentEvent body)
```
Create deployment event Create an deployment event for a System Profile. The request must contain the event as JSON representation. If the request does not contain a start and end date, the current server time will be used. The default severity is 'informational' and the default state is 'Created'. Events with a severity of 'informational' are automatically set to state 'Confirmed'. You can set such events to other states with a subsequent update. It is possible to specify the start date and leave the end date unset, the end date can then be provided later with an update. At least the JSON properties 'systemprofile' and 'message' have to be specified.

Parameters:

body - Event record (required)

Returns:

Call<Void>

getDeploymentEvent

@GET("api/v2/events/Deployment/{eventid}")
retrofit2.Call<DeploymentEvent> getDeploymentEvent(@Path("eventid")
                                                   String eventid)

Get deployment event record Get the JSON representation of a deployment event.

Parameters:: eventid - ID of event (required)
Returns:: Call<DeploymentEvent>

getIncident

@GET("api/v2/alerts/{alertid}")
retrofit2.Call<de.tsystems.mms.apm.performancesignature.dynatrace.model.Alert> getIncident(@Path("alertid")
                                                                                           String alertid)

Get Alert record Get the JSON representation of an alert (incident).

Parameters:: alertid - ID of alert (required)
Returns:: Call<AlertResponse>

getIncidents

@GET("api/v2/alerts")
retrofit2.Call<Alerts> getIncidents(@Query("systemprofile")
                                    String systemprofile,
                                    @Query("incidentrule")
                                    String incidentrule,
                                    @Query("state")
                                    String state,
                                    @Query("from")
                                    String from,
                                    @Query("to")
                                    String to)

List Alerts Get a list of all alerts (incidents) that match the filter settings. If no start and end date is specified, a default time frame of three days is selected.

Parameters:: systemprofile - System Profile id (optional); incidentrule - Incident Rule name (optional); state - Alert state (optional); from - Minimum start date of the alert (ISO8601) (optional); to - Maximum end date of the alert (ISO8601) (optional)
Returns:: Call<Alerts>

updateDeploymentEvent

@Headers("Content-Type:application/json")
@PUT("api/v2/events/Deployment/{eventid}")
retrofit2.Call<Void> updateDeploymentEvent(@Path("eventid")
                                           String eventid,
                                           @Body
                                           EventUpdate body)

Update deployment event record Several attributes of a deployment event can be modified by updating it. You can either retrieve the event record via the GET call first and then send the modified JSON object, or you could make a partial update by providing only the properties that should get updated.

Parameters:: eventid - ID of event (required); body - Event record (required)
Returns:: Call<Void>