LogpointApi.IncidentApi (logpoint_api v0.2.3)
This module provides an implementation of the Logpoint Incident API.
Summary
Functions
Add comments to a list of incidents.
Assign or re-assign a list of incidents.
Close a list of incidents.
Get a specific incident and its related data.
Get the states of incidents within a specific time range.
Get all incidents within a given time range.
Get users.
Reopen a list of incidents.
Resolve a list of incidents.
Functions
@spec add_comments( String.t(), LogpointApi.Credential.t(), LogpointApi.IncidentApi.IncidentCommentData.t() ) :: {:ok, map()} | {:error, String.t()}
Add comments to a list of incidents.
@spec assign_incidents( String.t(), LogpointApi.Credential.t(), LogpointApi.IncidentApi.IncidentIDs.t(), String.t() ) :: {:ok, map()} | {:error, String.t()}
Assign or re-assign a list of incidents.
@spec close_incidents( String.t(), LogpointApi.Credential.t(), LogpointApi.IncidentApi.IncidentIDs.t() ) :: {:ok, map()} | {:error, String.t()}
Close a list of incidents.
@spec get_data_from_incident( String.t(), LogpointApi.Credential.t(), LogpointApi.IncidentApi.Incident.t() ) :: {:ok, map()} | {:error, String.t()}
Get a specific incident and its related data.
@spec get_incident_states( String.t(), LogpointApi.Credential.t(), LogpointApi.IncidentApi.TimeRange.t() ) :: {:ok, map()} | {:error, String.t()}
Get the states of incidents within a specific time range.
@spec get_incidents( String.t(), LogpointApi.Credential.t(), LogpointApi.IncidentApi.TimeRange.t() ) :: {:ok, map()} | {:error, String.t()}
Get all incidents within a given time range.
@spec get_users(String.t(), LogpointApi.Credential.t()) :: {:ok, map()} | {:error, String.t()}
Get users.
@spec reopen_incidents( String.t(), LogpointApi.Credential.t(), LogpointApi.IncidentApi.IncidentIDs.t() ) :: {:ok, map()} | {:error, String.t()}
Reopen a list of incidents.
@spec resolve_incidents( String.t(), LogpointApi.Credential.t(), LogpointApi.IncidentApi.IncidentIDs.t() ) :: {:ok, map()} | {:error, String.t()}
Resolve a list of incidents.