OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.ScheduleRotation

API calls for all endpoints tagged ScheduleRotation.

Link to this section Summary

Functions

Create Schedule Rotation Creates a new schedule rotation

Delete Schedule Rotation Delete schedule rotation with given identifier

Get Schedule Rotation Returns schedule rotation with given id

List Schedule Rotations Returns list of schedule rotations

Update Schedule Rotation (Partial) Update schedule rotation with given id

Link to this section Functions

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

Create Schedule Rotation Creates a new schedule rotation

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of schedule which could be id or name
  • body (CreateScheduleRotationPayload): Request payload of created schedule rotation
  • 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 delete_schedule_rotation(connection, identifier, id, opts \\ [])
delete_schedule_rotation(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}

Delete Schedule Rotation Delete schedule rotation with given identifier

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of schedule which could be id or name
  • id (String.t): Identifier of schedule rotation
  • 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_rotation(connection, identifier, id, opts \\ [])

Get Schedule Rotation Returns schedule rotation with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of schedule which could be id or name
  • id (String.t): Identifier of schedule rotation
  • 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.GetScheduleRotationResponse{}} on success {:error, info} on failure

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

List Schedule Rotations Returns list of schedule rotations

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

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

Update Schedule Rotation (Partial) Update schedule rotation with given id

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of schedule which could be id or name
  • id (String.t): Identifier of schedule rotation
  • body (UpdateScheduleRotationPayload): Request payload of update schedule rotation action
  • 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