Project Channel

Package : spaceone.api.notification.v1

ProjectChannel

ProjectChannel Methods:

Method	Request	Response
create	CreateProjectChannelRequest	ProjectChannelInfo
update	UpdateProjectChannelRequest	ProjectChannelInfo
set_schedule	UpdateProjectChannelScheduleRequest	ProjectChannelInfo
set_subscription	UpdateProjectChannelSubscriptionRequest	ProjectChannelInfo
enable	ProjectChannelRequest	ProjectChannelInfo
disable	ProjectChannelRequest	ProjectChannelInfo
delete	ProjectChannelRequest	google.protobuf.Empty
get	GetProjectChannelRequest	ProjectChannelInfo
list	ProjectChannelQuery	ProjectChannelsInfo
stat	ProjectChannelStatQuery	google.protobuf.Struct

create

POST /notification/v1/project-channels

Creates a new Project Channel.Project channel is the definition of the channel that delivers the notification to the project when the notification is created.When creating a Project Channel, one of the protocols must be selected, and an notification is dispatched through the selected protocol.

Type	Message
Request	CreateProjectChannelRequest
Response	ProjectChannelInfo

update

PUT /notification/v1/project-channel/{project_channel_id}

Updates a Project Channel information.Protocol that has already been set cannot be changed. Instead, the data required to be dispatched notification for project channel is can be updated.

Type	Message
Request	UpdateProjectChannelRequest
Response	ProjectChannelInfo

set_schedule

PUT /notification/v1/project-channel/{project_channel_id}/schedule

Schedule settings for project channels.When a notification is created, you can set the day and time you want to receive it through the schedule.When you set the day of the week in the schedule, you can receive a notification only on the set day of the week.If you also set the start time and end time with day of the week, you can receive a notification only at the set time on the set day of the week.If there is no schedule, notifications will be dispatched at all times through project channel.

Type	Message
Request	UpdateProjectChannelScheduleRequest
Response	ProjectChannelInfo

set_subscription

PUT /notification/v1/project-channel/{project_channel_id}/subscription

Subscription settings for project channelsIf the project channel have subscriptions, notification is dispatched only if the topic of the notification is the same as the one set in the subscriptions.If no subscriptions in project channel, notifications will be dispatched all.

Type	Message
Request	UpdateProjectChannelSubscriptionRequest
Response	ProjectChannelInfo

enable

PUT /notification/v1/project-channel/{project_channel_id}/enable

Enables a Project Channel.If the disabled project channel is enabled, the project channel can be used again and the notification can be dispatched.Even if the project channel is enabled, if the protocol being used in the project channel is disabled, the notification is not dispatched.

Type	Message
Request	ProjectChannelRequest
Response	ProjectChannelInfo

disable

PUT /notification/v1/project-channel/{project_channel_id}/disable

Disables a Project Channel.If you disable the project channel, the notification will not be dispatched, even if they are created.

Type	Message
Request	ProjectChannelRequest
Response	ProjectChannelInfo

delete

DELETE /notification/v1/project-channel/{project_channel_id}

Delete the Project Channel.

Type	Message
Request	ProjectChannelRequest
Response	google.protobuf.Empty

get

GET /notification/v1/project-channel/{project_channel_id}

Gets a single Project Channel.

Type	Message
Request	GetProjectChannelRequest
Response	ProjectChannelInfo

list

GET /notification/v1/project-channels

POST /notification/v1/project-channels/search

Lists the specified Project Channel.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	ProjectChannelQuery
Response	ProjectChannelsInfo

stat

POST /notification/v1/project-channels/stat

Type	Message
Request	ProjectChannelStatQuery
Response	google.protobuf.Struct

Message

CreateProjectChannelRequest

Field	Type	Required	Description
protocol_id	string	✔	The ID of protocol that will be set in project channel.
name	string	✔	The name of Project Channel. It can have a maximum of 255 characters.
data	google.protobuf.Struct	✔	The data for using project channel.This data is encrypted and stored in the Secret service if JSON schema in the protocol's metadata is set to SECRET type.In this case, the secret ID that is stored in the security service will be returned and the data value will be empty.if JSON schema in the protocol's metadata is set to PLAIN_TEXT type, This data is not encrypted and stored directly in the DB.
is_subscribe	bool	✘	Indicates whether subscriptions will be used.
subscriptions	list of string	✔	When using subscriptions, it indicates the topic list to subscription.If is_subscribe is set to false, this value is ignored.
notification_level	NONE LV1 LV2 LV3 LV4 LV5	✔	Set the level of notification.If a notification has a level and a notification level that this channel can receive is set, a notification is dispatched only if the notification level is the same.
is_scheduled	bool	✘	Indicates whether schedule will be used.
schedule	ProjectChannelSchedule	✘	Schedule for which you want to receive notifications through the project channel.
tags	google.protobuf.Struct	✘	The tags for project channel.
project_id	string	✔	The ID of project to which the project channel belongs.
domain_id	string	✔	The ID of domain.

GetProjectChannelRequest

Field	Type	Required	Description
project_channel_id	string	✔	The ID of project channel.
domain_id	string	✔	The ID of domain.
only	list of string	✘	The list of the project channel information column you want to be returned. It must be specified in the ProjectChannelInfo.

ProjectChannelInfo

Field	Type	Description
project_channel_id	string	The ID of project channel.
name	string	The name of project channel
state	NONE ENABLED DISABLED	The state of project channel. ENABLED or DISABLED only.
data	google.protobuf.Struct	The data for using project channel.
secret_id	string	The ID of secret encrypted data in the security service
is_subscribe	bool	Indicates whether subscriptions will be used.
subscriptions	list of string	The topic list to subscription.
notification_level	NONE LV1 LV2 LV3 LV4 LV5	Set the level of notification.
is_scheduled	bool	Indicates whether schedule will be used.
schedule	ProjectChannelSchedule	Schedule for which you want to receive notifications through the project channel.
tags	google.protobuf.Struct	The tags for project channel.
protocol_id	string	The ID of protocol set in the project channel.
project_id	string	The ID of project to which the project channel belongs.
domain_id	string	The ID of domain.
created_at	string	Project channel creation time.

ProjectChannelQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘	Query format provided by SpaceONE. Please check the link for more information.
project_channel_id	string	✘	The ID of project channel.
name	string	✘	The name of project channel.
state	NONE ENABLED DISABLED	✘	The state of project channel. ENABLED or DISABLED only.
secret_id	string	✔
notification_level	NONE LV1 LV2 LV3 LV4 LV5	✘	The level of notification.
protocol_id	string	✘	The ID of protocol set in the project channel.
project_id	string	✘	The ID of project to which the project channel belongs.
domain_id	string	✔	The ID of domain.

ProjectChannelRequest

Field	Type	Required	Description
project_channel_id	string	✔	The ID of project channel.
domain_id	string	✔	The ID of domain.

ProjectChannelSchedule

Field	Type	Description
day_of_week	NONE MON TUE WED THU FRI SAT SUN	Day of the week to be notified.As a list type, only types that can be specified from MON to SUN can be set.
start_hour	int32	Start time to receive notifications.Only integer type can be set, and 0 to 23 can be.
end_hour	int32	End time to receive notifications.Only integer type can be set, and 1 to 24 can be.

ProjectChannelStatQuery

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

ProjectChannelsInfo

Field	Type	Description
results	list of ProjectChannelInfo	List of queried project channels.
total_count	int32	Total counts of queried project channels.

UpdateProjectChannelRequest

Field	Type	Required	Description
project_channel_id	string	✔	The ID of project channel.
name	string	✘	The name of Project Channel. It can have a maximum of 255 characters.
data	google.protobuf.Struct	✔	The data for using project channel.This data is encrypted and stored in the Secret service if JSON schema in the protocol's metadata is set to SECRET type.In this case, the secret ID that is stored in the security service will be returned and the data value will be empty.if JSON schema in the protocol's metadata is set to PLAIN_TEXT type, This data is not encrypted and stored directly in the DB.
notification_level	NONE LV1 LV2 LV3 LV4 LV5	✔	Set the level of notification.If a notification has a level and a notification level that this channel can receive is set, a notification is dispatched only if the notification level is the same.
tags	google.protobuf.Struct	✘	The tags for project channel.
domain_id	string	✔	The ID of domain.

UpdateProjectChannelScheduleRequest

Field	Type	Required	Description
project_channel_id	string	✔	The ID of project channel.
is_scheduled	bool	✔	Indicates whether schedule will be used.
schedule	ProjectChannelSchedule	✘	Schedule for which you want to receive notifications through the project channel.
domain_id	string	✔	The ID of domain.

UpdateProjectChannelSubscriptionRequest

Field	Type	Required	Description
project_channel_id	string	✔	The ID of project channel.
is_subscribe	bool	✔	Indicates whether subscriptions will be used.
subscriptions	list of string	✔	When using subscriptions, it indicates the topic list to subscription.If is_subscribe is set to false, this value is ignored.
domain_id	string	✔	The ID of domain.