OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.NotificationRuleStep

API calls for all endpoints tagged NotificationRuleStep.

Link to this section Summary

Functions

Create Notification Rule Step Creates a new notification rule step

Delete Notification Rule Step Deletes a notification rule step using user identifier, rule id, notification rule step id

Disable Notification Rule Step Disables a new notification rule step

Enable Notification Rule Step Enables a new notification rule step

Get Notification Rule Step Returns notification rule step with given user identifier and rule id

List Notification Rule Steps Returns list of notification rule steps

Update Notification Rule Step (Partial) Update a notification rule step with given user identifier, rule id, and notification rule step id

Link to this section Functions

Link to this function create_notification_rule_step(connection, identifier, rule_id, body, opts \\ [])

Create Notification Rule Step Creates a new notification rule step

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • body (CreateNotificationRuleStepPayload): Request payload to create notification rule step
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Delete Notification Rule Step Deletes a notification rule step using user identifier, rule id, notification rule step id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • id (String.t): Id of the rule step will be changed.
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Disable Notification Rule Step Disables a new notification rule step

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • id (String.t): Id of the rule step will be changed.
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Enable Notification Rule Step Enables a new notification rule step

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • id (String.t): Id of the rule step will be changed.
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Get Notification Rule Step Returns notification rule step with given user identifier and rule id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • id (String.t): Id of the rule step will be changed.
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

List Notification Rule Steps Returns list of notification rule steps

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • opts (KeywordList): [optional] Optional parameters

Returns

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

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

Update Notification Rule Step (Partial) Update a notification rule step with given user identifier, rule id, and notification rule step id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user to be searched
  • rule_id (String.t): Id of the notification rule that step will belong to.
  • id (String.t): Id of the rule step will be changed.
  • opts (KeywordList): [optional] Optional parameters

    • :body (UpdateNotificationRuleStepPayload): Request payload of update schedule action

Returns

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