OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.WhoIsOnCall

API calls for all endpoints tagged WhoIsOnCall.

Link to this section Summary

Functions

Export On-Call User Exports personal on-call timeline of 3 months to a .ics file

Get Next On Calls Gets next on-call participants of a specific schedule

Get On Calls Gets current on-call participants of a specific schedule

List On Calls Lists current on-call participants of all schedules

Link to this section Functions

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

Export On-Call User Exports personal on-call timeline of 3 months to a .ics file

Parameters

  • connection (OpsGenieRESTAPI.Connection): Connection to server
  • identifier (String.t): Identifier of the user. Should be either 'id' or 'username' of the user
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %OpsGenieRESTAPI.Model.binary(){}} on success {:error, info} on failure

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

Get Next On Calls Gets next on-call participants of a specific schedule

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'
    • :flat (boolean()): Retrieves user names of all on call participants if enabled
    • :date (DateTime.t): Starting date of the timeline

Returns

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

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

Get On Calls Gets current on-call participants of a specific schedule

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'
    • :flat (boolean()): Retrieves user names of all on call participants if enabled
    • :date (DateTime.t): Starting date of the timeline

Returns

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

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

List On Calls Lists current on-call participants of all schedules

Parameters

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

    • :flat (boolean()): Retrieves user names of all on call participants if enabled
    • :date (DateTime.t): Starting date of the timeline

Returns

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