Skip to content

NotificationApi.md

Latest commit

 

History

History
265 lines (138 loc) · 7.3 KB

NotificationApi.md

File metadata and controls

265 lines (138 loc) · 7.3 KB

\NotificationApi

All URIs are relative to http://localhost:8989

Method HTTP request Description
create_notification POST /api/v3/notification
create_notification_action_by_name POST /api/v3/notification/action/{name}
delete_notification DELETE /api/v3/notification/{id}
get_notification_by_id GET /api/v3/notification/{id}
list_notification GET /api/v3/notification
list_notification_schema GET /api/v3/notification/schema
test_notification POST /api/v3/notification/test
testall_notification POST /api/v3/notification/testall
update_notification PUT /api/v3/notification/{id}

create_notification

models::NotificationResource create_notification(force_save, notification_resource)

Parameters

Name Type Description Required Notes
force_save Option<bool> [default to false]
notification_resource Option<NotificationResource>

Return type

models::NotificationResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_notification_action_by_name

create_notification_action_by_name(name, notification_resource)

Parameters

Name Type Description Required Notes
name String [required]
notification_resource Option<NotificationResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_notification

delete_notification(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_notification_by_id

models::NotificationResource get_notification_by_id(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

models::NotificationResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_notification

Vecmodels::NotificationResource list_notification()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::NotificationResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_notification_schema

Vecmodels::NotificationResource list_notification_schema()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::NotificationResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_notification

test_notification(force_test, notification_resource)

Parameters

Name Type Description Required Notes
force_test Option<bool> [default to false]
notification_resource Option<NotificationResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

testall_notification

testall_notification()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_notification

models::NotificationResource update_notification(id, force_save, notification_resource)

Parameters

Name Type Description Required Notes
id i32 [required]
force_save Option<bool> [default to false]
notification_resource Option<NotificationResource>

Return type

models::NotificationResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]