OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.Escalation

API calls for all endpoints tagged Escalation.

Link to this section Summary

Functions

Create Escalation Creates a new escalation

Delete Escalation Deletes an escalation using escalation 'id' or 'name'

Get Escalation Returns escalation with given 'id' or 'name'

List Escalations Returns list of escalations

Update Escalation (Partial) Updates the escalation using escalation 'id' or 'name'

Link to this section Functions

Link to this function create_escalation(connection, body, opts \\ [])

Create Escalation Creates a new escalation

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • body (CreateEscalationPayload): Request payload of created escalation
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure

Link to this function delete_escalation(connection, identifier, opts \\ [])
delete_escalation(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Delete Escalation Deletes an escalation using escalation 'id' or 'name'

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of escalation which could be escalation 'id' or 'name'
  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure

Link to this function get_escalation(connection, identifier, opts \\ [])

Get Escalation Returns escalation with given 'id' or 'name'

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of escalation which could be escalation 'id' or 'name'
  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'

Returns

{:ok, %OpsGenieRESTAPI.Model.GetEscalationResponse{}} on success {:error, info} on failure

Link to this function list_escalations(connection, opts \\ [])
list_escalations(Tesla.Env.client(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.ListEscalationsResponse.t()}
  | {:error, Tesla.Env.t()}

List Escalations Returns list of escalations

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.ListEscalationsResponse{}} on success {:error, info} on failure

Link to this function update_escalation(connection, identifier, opts \\ [])
update_escalation(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Update Escalation (Partial) Updates the escalation using escalation 'id' or 'name'

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of escalation which could be escalation 'id' or 'name'
  • opts (KeywordList): [optional] Optional parameters

    • :identifier_type (String.t): Type of the identifier that is provided as an in-line parameter. Possible values are 'id' or 'name'
    • :body (UpdateEscalationPayload): Request payload of update escalation

Returns

{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure