OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.TeamRoutingRule

API calls for all endpoints tagged TeamRoutingRule.

Link to this section Summary

Functions

Change Team Routing Rule Order Change the order of team routing rule with given id

Create Team Routing Rule Creates a new team routing rule

Delete Team Routing Rule Delete team routing rule with given id

Get Team Routing Rule Returns team routing rule with given id

List Team Routing Rules Returns list of team routing rules

Update Team Routing Rule (Partial) Update routing rule of the team

Link to this section Functions

Link to this function change_team_routing_rule_order(connection, identifier, id, body, opts \\ [])

Change Team Routing Rule Order Change the order of team routing rule with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the team
  • id (String.t): Id of the team routing rule
  • body (ChangeTeamRoutingRuleOrderPayload): Request payload of change team routing rule order action
  • opts (KeywordList): [optional] Optional parameters

    • :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Returns

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

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

Create Team Routing Rule Creates a new team routing rule

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the team
  • body (CreateTeamRoutingRulePayload): Request payload of createTeamRoutingRule
  • opts (KeywordList): [optional] Optional parameters

    • :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Returns

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

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

Delete Team Routing Rule Delete team routing rule with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the team
  • id (String.t): Id of the team routing rule
  • opts (KeywordList): [optional] Optional parameters

    • :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Returns

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

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

Get Team Routing Rule Returns team routing rule with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the team
  • id (String.t): Id of the team routing rule
  • opts (KeywordList): [optional] Optional parameters

    • :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Returns

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

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

List Team Routing Rules Returns list of team routing rules

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the team
  • opts (KeywordList): [optional] Optional parameters

    • :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'

Returns

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

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

Update Team Routing Rule (Partial) Update routing rule of the team

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the team
  • id (String.t): Id of the team routing rule
  • opts (KeywordList): [optional] Optional parameters

    • :team_identifier_type (String.t): Type of the identifier. Possible values are 'id' and 'name'. Default value is 'id'
    • :body (UpdateTeamRoutingRulePayload): Request payload of update Team Routing Rule action

Returns

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