OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.ScheduleOverride

API calls for all endpoints tagged ScheduleOverride.

Link to this section Summary

Functions

Create Schedule Override Creates a schedule override for the specified user and schedule

Delete Schedule Override Delete schedule override with given alias

Get Schedule Override Gets schedule override details with given alias

List Schedule Overrides Returns list of schedule overrides

Update Schedule Override Update schedule override with given alias

Link to this section Functions

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

Create Schedule Override Creates a schedule override for the specified user and schedule

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of schedule which could be id or name
  • body (CreateScheduleOverridePayload): Request payload of created schedule override
  • opts (KeywordList): [optional] Optional parameters

    • :schedule_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.CreateScheduleOverrideResponse{}} on success {:error, info} on failure

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

Delete Schedule Override Delete schedule override with given alias

Parameters

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

    • :schedule_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_schedule_override(connection, identifier, alias, opts \\ [])

Get Schedule Override Gets schedule override details with given alias

Parameters

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

    • :schedule_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.GetScheduleOverrideResponse{}} on success {:error, info} on failure

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

List Schedule Overrides Returns list of schedule overrides

Parameters

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

    • :schedule_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.ListScheduleOverrideResponse{}} on success {:error, info} on failure

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

Update Schedule Override Update schedule override with given alias

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of schedule which could be id or name
  • alias (String.t): Alias of the schedule override
  • body (UpdateScheduleOverridePayload): Request payload of update schedule override
  • opts (KeywordList): [optional] Optional parameters

    • :schedule_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.UpdateScheduleOverrideResponse{}} on success {:error, info} on failure