Notification

Package : spaceone.api.notification.v1

Notification

Notification Methods:

NO	Method	Request Type	Response Type	Description
1	create	CreateNotificationRequest	google.protobuf.Empty	Creates a new Notification.A notification is a definition of an event to be delivered to the user.When a notification is created, it is propagated through the channel of the project to which the notification belongs,and if an internal channel or user channel is set, the notification is also propagated to the user.
2	delete	NotificationRequest	google.protobuf.Empty	Delete the Notification.
3	delete_all	NotificationDeleteAllRequest	google.protobuf.Empty	Delete all Notifications.
4	set_read	SetReadNotificationRequest	google.protobuf.Empty	Change the notifications to read status.When the notification is created, the is_read value is False, and when the set_read method is used, the read state can be changed.
5	get	GetNotificationRequest	NotificationInfo	Gets a single Notification.
6	list	NotificationQuery	NotificationsInfo	Lists the specified notifications.Can search information using the query format provided by SpaceONE.Detailed information about Query format can be checked in the Search Query pages.
7	stat	NotificationStatQuery	google.protobuf.Struct

create

POST /notification/v1/notifications

Creates a new Notification.A notification is a definition of an event to be delivered to the user.When a notification is created, it is propagated through the channel of the project to which the notification belongs,and if an internal channel or user channel is set, the notification is also propagated to the user.

Type	Message
Request	CreateNotificationRequest
Response	google.protobuf.Empty

delete

DELETE /notification/v1/notification/{notification_id}

Delete the Notification.

Type	Message
Request	NotificationRequest
Response	google.protobuf.Empty

delete_all

POST /notification/v1/notification/delete_all

Delete all Notifications.

Type	Message
Request	NotificationDeleteAllRequest
Response	google.protobuf.Empty

set_read

POST /notification/v1/notifications/read

Change the notifications to read status.When the notification is created, the is_read value is False, and when the set_read method is used, the read state can be changed.

Type	Message
Request	SetReadNotificationRequest
Response	google.protobuf.Empty

get

GET /notification/v1/notification/{notification_id}

Gets a single Notification.

Type	Message
Request	GetNotificationRequest
Response	NotificationInfo

list

GET /notification/v1/notifications

POST /notification/v1/notifications/search

Lists the specified notifications.Can search information using the query format provided by SpaceONE.Detailed information about Query format can be checked in the Search Query pages.

Type	Message
Request	NotificationQuery
Response	NotificationsInfo

stat

POST /notification/v1/notifications/stat

Type	Message
Request	NotificationStatQuery
Response	google.protobuf.Struct

Message

CreateNotificationRequest

No	Field	Type	Required	Description
1	resource_type	string	✅	The type of resource to which the notification is dispatched.Currently, only "identity.Project" or "identity.User" can be set.
2	resource_id	string	✅	The ID of the resource to which notifications are dispatched.If resource_type is "identity.Project", then resource_id requires a project ID values.If resource_type is "identity.User", then resource_id requires a user ID value.
3	topic	string	✅	The topic of notification.
4	message	google.protobuf.Struct	✅	This message is used for each protocol.
5	notification_type	NOTIFICATION_TYPE_NONE INFO ERROR SUCCESS WARNING	❌	The type of notification.
6	notification_level	NONE ALL LV1 LV2 LV3 LV4 LV5	❌	The level of notification.
7	domain_id	string	✅	The ID of domain.

GetNotificationRequest

No	Field	Type	Required	Description
1	notification_id	string	✅	The ID of Notification.
2	domain_id	string	✅	The ID of domain.
3	only	list of string	❌	The list of the notification information column you want to be returned. It must be specified in the NotificationInfo.

NotificationDeleteAllRequest

No	Field	Type	Required	Description
1	users	list of string	✅	ID list of users to be deleted
2	domain_id	string

NotificationInfo

No	Field	Type	Description
1	notification_id	string	The ID of notification.
2	topic	string	The topic of notification.
3	message	google.protobuf.Struct	The contents of notification.This message is used for each protocol.
4	notification_type	NOTIFICATION_TYPE_NONE INFO ERROR SUCCESS WARNING	The type of notification.
5	notification_level	NONE ALL LV1 LV2 LV3 LV4 LV5	The level of notification.
6	is_read	bool	Whether or not to check the notification.If notification has been returned at least once through the Get or List method, is_read is changed to True.
7	user_id	string	The ID of user to whom the notification was dispatched.
8	domain_id	string	The ID of domain
9	created_at	string	Notification creation time.

NotificationQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.Query	❌	Query format provided by SpaceONE. Please check the link for more information.
2	notification_id	string	❌	The ID of notification.
3	topic	string	❌	The topic of notification.
4	notification_type	NOTIFICATION_TYPE_NONE INFO ERROR SUCCESS WARNING	❌	The type of notification.
5	notification_level	NONE ALL LV1 LV2 LV3 LV4 LV5	❌	The level of notification.
6	is_read	bool	✅	Whether or not to check the notification.If is_read is False, the user has not checked the notification yet.
7	parent_notification_id	string	❌	The ID of parent notification. Not used yet.
8	project_id	string	❌	The project ID to which the notification will be dispatched.
9	user_id	string	❌	The ID of user.
10	domain_id	string	✅	The ID of domain.

NotificationRequest

No	Field	Type	Required	Description
1	notification_id	string	✅	The ID of Notification.
2	domain_id	string	✅	The ID of domain.

NotificationStatQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.StatisticsQuery	✅	Statistics Query format provided by SpaceONE. Please check the link for more information.
2	domain_id	string	✅	The ID of domain.

NotificationsInfo

No	Field	Type	Description
1	results	list of NotificationInfo	List of queried notifications.
2	total_count	int32	Total counts of queried notifications.

SetReadNotificationRequest

No	Field	Type	Required	Description
1	notifications	list of string	✅	The ID list of notification that want to change read status.
2	domain_id	string	✅	The ID of domain.