ProjectChannel #

A ProjectChannel is a destination where Notifications are delivered. Notifications are generated via the Protocol set by each Project.

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	Empty
get	ProjectChannelRequest	ProjectChannelInfo
list	ProjectChannelQuery	ProjectChannelsInfo
stat	ProjectChannelStatQuery	Struct

create #

Creates a new ProjectChannel. ProjectChannel is a channel that delivers a Notification to the Project when the Notification is created. When creating a ProjectChannel, one Protocol must be selected, and a Notification is dispatched via the selected Protocol.

POST /notification/v1/project-channel/create

Request Example

CreateProjectChannelRequest

protocol_id (string) Required
The ID of protocol that will be set in project channel.
name (string) Required
The name of Project Channel. It can have a maximum of 255 characters.
data (Struct) Required
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.
project_id (string) Required
The ID of project to which the project channel belongs.
is_subscribe (bool)
Indicates whether subscriptions will be used.
subscriptions (string) Repeated
When using subscriptions, it indicates the topic list to subscription. If is_subscribe is set to false, this value is ignored.
notification_level (NotificationLevel)
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 (Struct)
The tags for project channel.

{
   "protocol_id": "protocol-ab94ea7d574e",
   "name": "sms-test",
   "data": {
       "phone_number": "01011112222"
   },
   "is_subscribe": true,
   "subscriptions": ["monitoring.Alert"],
   "notification_level": "LV1",
   "is_scheduled": true,
   "schedule": {
       "day_of_week": [
           "MON",
           "TUE",
           "WED",
           "THU",
           "FRI"
       ],
       "end_hour": 9
   },
   "project_id": "project-52a423012d5e"
}

Response Example

ProjectChannelInfo

project_channel_id (string) Required
The ID of project channel.
name (string) Required
The name of project channel
state (ProjectChannelState) Required
The state of project channel. ENABLED or DISABLED only.
data (Struct) Required
The data for using project channel.
is_subscribe (bool) Required
Indicates whether subscriptions will be used.
subscriptions (string) Repeated Required
The topic list to subscription.
is_scheduled (bool) Required
Indicates whether schedule will be used.
schedule (ProjectChannelSchedule) Required
Schedule for which you want to receive notifications through the project channel.
notification_level (NotificationLevel) Required
Set the level of notification.
tags (Struct) Required
The tags for project channel.
domain_id (string) Required
The ID of domain.
workspace_id (string) Required
The ID of workspace
project_id (string) Required
The ID of project to which the project channel belongs.
protocol_id (string) Required
The ID of protocol set in the project channel.
secret_id (string) Required
The ID of secret encrypted data in the security service
created_at (string) Required
Project channel creation time.

{
   "project_channel_id": "project-ch-488df94d026d",
   "name": "sms-test",
   "state": "ENABLED",
   "data": {
       "phone_number": "01011112222"
   },
   "notification_level": "LV1",
   "tags": {},
   "protocol_id": "protocol-ab94ea7d574e",
   "project_id": "project-aa723eed3d69",
   "workspace_id": "workspace-123456789012"
   "domain_id": "domain-58010aa2e451",
   "created_at": "2022-06-13T07:35:28.305Z"
}

update #

Updates a specific ProjectChannel. A ProjectChannel that has already been configured cannot be changed. Instead, the data required for dispatching Notifications to a ProjectChannel can be updated.

POST /notification/v1/project-channel/update

Request Example

UpdateProjectChannelRequest

project_channel_id (string) Required
The ID of project channel.
domain_id (string) Required
The ID of domain.
name (string)
The name of Project Channel. It can have a maximum of 255 characters.
data (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 (NotificationLevel)
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 (Struct)
The tags for project channel.

{
   "project_channel_id": "project-ch-488df94d026d",
   "name": "sms2-test",
   "data": {
       "phone_number": "01033334444"
   },
   "notification_level": "LV2",
   "tags": {
       "a": "b"
   }
}

Response Example

ProjectChannelInfo

project_channel_id (string) Required
The ID of project channel.
name (string) Required
The name of project channel
state (ProjectChannelState) Required
The state of project channel. ENABLED or DISABLED only.
data (Struct) Required
The data for using project channel.
is_subscribe (bool) Required
Indicates whether subscriptions will be used.
subscriptions (string) Repeated Required
The topic list to subscription.
is_scheduled (bool) Required
Indicates whether schedule will be used.
schedule (ProjectChannelSchedule) Required
Schedule for which you want to receive notifications through the project channel.
notification_level (NotificationLevel) Required
Set the level of notification.
tags (Struct) Required
The tags for project channel.
domain_id (string) Required
The ID of domain.
workspace_id (string) Required
The ID of workspace
project_id (string) Required
The ID of project to which the project channel belongs.
protocol_id (string) Required
The ID of protocol set in the project channel.
secret_id (string) Required
The ID of secret encrypted data in the security service
created_at (string) Required
Project channel creation time.

{
   "project_channel_id": "project-ch-488df94d026d",
   "name": "sms-test",
   "state": "ENABLED",
   "data": {
       "phone_number": "01011112222"
   },
   "notification_level": "LV1",
   "tags": {},
   "protocol_id": "protocol-ab94ea7d574e",
   "project_id": "project-aa723eed3d69",
   "workspace_id": "workspace-123456789012"
   "domain_id": "domain-58010aa2e451",
   "created_at": "2022-06-13T07:35:28.305Z"
}

set_schedule #

Sets a schedule for a ProjectChannel. A schedule defines the time to receive a Notification. When a Notification is created, you can set the day of the week and time you want to receive it. When you set the day of the week, you can receive a notification only on the day of the week you set. If you also set the start time and end time with the day of the week, you can receive a Notification only at the scheduled time on the day of the week you set. If there is no schedule set in a ProjectChannel, Notifications will be dispatched at all times via the ProjectChannel.

POST /notification/v1/project-channel/set-schedule

Request Example

UpdateProjectChannelScheduleRequest

project_channel_id (string) Required
The ID of project channel.
is_scheduled (bool) Required
Indicates whether schedule will be used.
schedule (ProjectChannelSchedule)
Schedule for which you want to receive notifications through the project channel.

{
   "project_channel_id": "project-ch-488df94d026d",
   "is_scheduled": true,
   "schedule": {
       "day_of_week": [
           "MON",
           "WED",
           "FRI"
       ],
       "end_hour": 9
   }
}

Response Example

ProjectChannelInfo

project_channel_id (string) Required
The ID of project channel.
name (string) Required
The name of project channel
state (ProjectChannelState) Required
The state of project channel. ENABLED or DISABLED only.
data (Struct) Required
The data for using project channel.
is_subscribe (bool) Required
Indicates whether subscriptions will be used.
subscriptions (string) Repeated Required
The topic list to subscription.
is_scheduled (bool) Required
Indicates whether schedule will be used.
schedule (ProjectChannelSchedule) Required
Schedule for which you want to receive notifications through the project channel.
notification_level (NotificationLevel) Required
Set the level of notification.
tags (Struct) Required
The tags for project channel.
domain_id (string) Required
The ID of domain.
workspace_id (string) Required
The ID of workspace
project_id (string) Required
The ID of project to which the project channel belongs.
protocol_id (string) Required
The ID of protocol set in the project channel.
secret_id (string) Required
The ID of secret encrypted data in the security service
created_at (string) Required
Project channel creation time.

{
   "project_channel_id": "project-ch-488df94d026d",
   "name": "sms-test",
   "state": "ENABLED",
   "data": {
       "phone_number": "01011112222"
   },
   "notification_level": "LV1",
   "tags": {},
   "protocol_id": "protocol-ab94ea7d574e",
   "project_id": "project-aa723eed3d69",
   "workspace_id": "workspace-123456789012"
   "domain_id": "domain-58010aa2e451",
   "created_at": "2022-06-13T07:35:28.305Z"
}

set_subscription #

Sets a subscription for a ProjectChannel. A subscription is a topic for channels to subscribe to and get notified about. If a ProjectChannel has subscriptions, a Notification is dispatched only if the topic of the Notification is the same as the one set in the subscriptions. If there is no subscription in a ProjectChannel, all Notifications will be dispatched.

POST /notification/v1/project-channel/set-subscription

Request Example

UpdateProjectChannelSubscriptionRequest

project_channel_id (string) Required
The ID of project channel.
is_subscribe (bool) Required
Indicates whether subscriptions will be used.
subscriptions (string) Repeated
When using subscriptions, it indicates the topic list to subscription. If is_subscribe is set to false, this value is ignored.

{
   "project_channel_id": "project-ch-cff007433a23",
   "is_subscribe": true,
   "subscriptions": [
       "monitoring.Alert"
   ]
}

Response Example

ProjectChannelInfo

project_channel_id (string) Required
The ID of project channel.
name (string) Required
The name of project channel
state (ProjectChannelState) Required
The state of project channel. ENABLED or DISABLED only.
data (Struct) Required
The data for using project channel.
is_subscribe (bool) Required
Indicates whether subscriptions will be used.
subscriptions (string) Repeated Required
The topic list to subscription.
is_scheduled (bool) Required
Indicates whether schedule will be used.
schedule (ProjectChannelSchedule) Required
Schedule for which you want to receive notifications through the project channel.
notification_level (NotificationLevel) Required
Set the level of notification.
tags (Struct) Required
The tags for project channel.
domain_id (string) Required
The ID of domain.
workspace_id (string) Required
The ID of workspace
project_id (string) Required
The ID of project to which the project channel belongs.
protocol_id (string) Required
The ID of protocol set in the project channel.
secret_id (string) Required
The ID of secret encrypted data in the security service
created_at (string) Required
Project channel creation time.

{
   "project_channel_id": "project-ch-488df94d026d",
   "name": "sms-test",
   "state": "ENABLED",
   "data": {
       "phone_number": "01011112222"
   },
   "notification_level": "LV1",
   "tags": {},
   "protocol_id": "protocol-ab94ea7d574e",
   "project_id": "project-aa723eed3d69",
   "workspace_id": "workspace-123456789012"
   "domain_id": "domain-58010aa2e451",
   "created_at": "2022-06-13T07:35:28.305Z"
}

enable #

Enables a specific ProjectChannel. If a ProjectChannel is enabled, the ProjectChannel can be used and the Notification can be dispatched. Even if a ProjectChannel is enabled, if the Protocol used in the ProjectChannel is disabled, the Notification is not dispatched.

POST /notification/v1/project-channel/enable

Request Example

ProjectChannelRequest

project_channel_id (string) Required
The ID of project channel.

{
   "project_channel_id": "project-ch-ffdb1d6cc774"
}

Response Example

ProjectChannelInfo

project_channel_id (string) Required
The ID of project channel.
name (string) Required
The name of project channel
state (ProjectChannelState) Required
The state of project channel. ENABLED or DISABLED only.
data (Struct) Required
The data for using project channel.
is_subscribe (bool) Required
Indicates whether subscriptions will be used.
subscriptions (string) Repeated Required
The topic list to subscription.
is_scheduled (bool) Required
Indicates whether schedule will be used.
schedule (ProjectChannelSchedule) Required
Schedule for which you want to receive notifications through the project channel.
notification_level (NotificationLevel) Required
Set the level of notification.
tags (Struct) Required
The tags for project channel.
domain_id (string) Required
The ID of domain.
workspace_id (string) Required
The ID of workspace
project_id (string) Required
The ID of project to which the project channel belongs.
protocol_id (string) Required
The ID of protocol set in the project channel.
secret_id (string) Required
The ID of secret encrypted data in the security service
created_at (string) Required
Project channel creation time.

{
   "project_channel_id": "project-ch-488df94d026d",
   "name": "sms-test",
   "state": "ENABLED",
   "data": {
       "phone_number": "01011112222"
   },
   "notification_level": "LV1",
   "tags": {},
   "protocol_id": "protocol-ab94ea7d574e",
   "project_id": "project-aa723eed3d69",
   "workspace_id": "workspace-123456789012"
   "domain_id": "domain-58010aa2e451",
   "created_at": "2022-06-13T07:35:28.305Z"
}

disable #

Disables a specific ProjectChannel. If a ProjectChannel is disabled, the Notification is not dispatched, even if it is created.

POST /notification/v1/project-channel/disable

Request Example

ProjectChannelRequest

project_channel_id (string) Required
The ID of project channel.

{
   "project_channel_id": "project-ch-ffdb1d6cc774"
}

Response Example

ProjectChannelInfo

project_channel_id (string) Required
The ID of project channel.
name (string) Required
The name of project channel
state (ProjectChannelState) Required
The state of project channel. ENABLED or DISABLED only.
data (Struct) Required
The data for using project channel.
is_subscribe (bool) Required
Indicates whether subscriptions will be used.
subscriptions (string) Repeated Required
The topic list to subscription.
is_scheduled (bool) Required
Indicates whether schedule will be used.
schedule (ProjectChannelSchedule) Required
Schedule for which you want to receive notifications through the project channel.
notification_level (NotificationLevel) Required
Set the level of notification.
tags (Struct) Required
The tags for project channel.
domain_id (string) Required
The ID of domain.
workspace_id (string) Required
The ID of workspace
project_id (string) Required
The ID of project to which the project channel belongs.
protocol_id (string) Required
The ID of protocol set in the project channel.
secret_id (string) Required
The ID of secret encrypted data in the security service
created_at (string) Required
Project channel creation time.

{
   "project_channel_id": "project-ch-488df94d026d",
   "name": "sms-test",
   "state": "ENABLED",
   "data": {
       "phone_number": "01011112222"
   },
   "notification_level": "LV1",
   "tags": {},
   "protocol_id": "protocol-ab94ea7d574e",
   "project_id": "project-aa723eed3d69",
   "workspace_id": "workspace-123456789012"
   "domain_id": "domain-58010aa2e451",
   "created_at": "2022-06-13T07:35:28.305Z"
}

delete #

Deletes a specific ProjectChannel.

POST /notification/v1/project-channel/delete

Request Example

ProjectChannelRequest

project_channel_id (string) Required
The ID of project channel.

{
   "project_channel_id": "project-ch-ffdb1d6cc774"
}

get #

Gets a specific ProjectChannel. Prints detailed information about the ProjectChannel.

POST /notification/v1/project-channel/get

Request Example

ProjectChannelRequest

project_channel_id (string) Required
The ID of project channel.

{
   "project_channel_id": "project-ch-ffdb1d6cc774"
}

Response Example

ProjectChannelInfo

project_channel_id (string) Required
The ID of project channel.
name (string) Required
The name of project channel
state (ProjectChannelState) Required
The state of project channel. ENABLED or DISABLED only.
data (Struct) Required
The data for using project channel.
is_subscribe (bool) Required
Indicates whether subscriptions will be used.
subscriptions (string) Repeated Required
The topic list to subscription.
is_scheduled (bool) Required
Indicates whether schedule will be used.
schedule (ProjectChannelSchedule) Required
Schedule for which you want to receive notifications through the project channel.
notification_level (NotificationLevel) Required
Set the level of notification.
tags (Struct) Required
The tags for project channel.
domain_id (string) Required
The ID of domain.
workspace_id (string) Required
The ID of workspace
project_id (string) Required
The ID of project to which the project channel belongs.
protocol_id (string) Required
The ID of protocol set in the project channel.
secret_id (string) Required
The ID of secret encrypted data in the security service
created_at (string) Required
Project channel creation time.

{
   "project_channel_id": "project-ch-488df94d026d",
   "name": "sms-test",
   "state": "ENABLED",
   "data": {
       "phone_number": "01011112222"
   },
   "notification_level": "LV1",
   "tags": {},
   "protocol_id": "protocol-ab94ea7d574e",
   "project_id": "project-aa723eed3d69",
   "workspace_id": "workspace-123456789012"
   "domain_id": "domain-58010aa2e451",
   "created_at": "2022-06-13T07:35:28.305Z"
}

list #

Gets a list of all ProjectChannels. You can use a query to get a filtered list of ProjectChannels.

POST /notification/v1/project-channel/list

Request Example

ProjectChannelQuery

query (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 (ProjectChannelState)
The state of project channel. ENABLED or DISABLED only.
is_subscribe (bool)
Indicates whether subscriptions will be used.
is_scheduled (bool)
Indicates whether schedule will be used.
notification_level (NotificationLevel)
The level of notification.
project_id (string)
The ID of project to which the project channel belongs.
protocol_id (string)
The ID of protocol set in the project channel.
secret_id (string)
The ID of secret encrypted data in the security service

{
   "query": {
       "filter": [
           {
               "key": "state",
               "value": "ENABLED",
               "operator": "eq"
           }
       ]
   }
}

Response Example

ProjectChannelsInfo

results (ProjectChannelInfo) Repeated Required
List of queried project channels.
total_count (int32) Required
Total counts of queried project channels.

{
   "results": [
       {
           "project_channel_id": "project-ch-473efcfde4b1",
           "name": "Email Groups",
           "state": "ENABLED",
           "data": {
               "email": "sykim1@cloudforet.io, sykim2@cloudforet.io"
           },
           "notification_level": "LV1",
           "tags": {},
           "protocol_id": "protocol-e000a677ebdb",
           "project_id": "project-28cf4f2e6645",
           "domain_id": "domain-58010aa2e451",
           "created_at": "2022-04-18T01:22:01.182Z"
       },
       {
           "project_channel_id": "project-ch-98845ba0f975",
           "name": "Song Email",
           "state": "ENABLED",
           "data": {
               "email": "sykim@mz.co.kr"
           },
           "notification_level": "LV1",
           "tags": {},
           "protocol_id": "protocol-e000a677ebdb",
           "project_id": "project-28cf4f2e6645",
           "domain_id": "domain-58010aa2e451",
           "created_at": "2022-04-18T01:17:40.741Z"
       }
   ],
   "total_count": 2
}

stat #

POST /notification/v1/project-channel/stat

Message #

CreateProjectChannelRequest #

protocol_id (string) Required
The ID of protocol that will be set in project channel.
name (string) Required
The name of Project Channel. It can have a maximum of 255 characters.
data (Struct) Required
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.
project_id (string) Required
The ID of project to which the project channel belongs.
is_subscribe (bool)
Indicates whether subscriptions will be used.
subscriptions (string) Repeated
When using subscriptions, it indicates the topic list to subscription. If is_subscribe is set to false, this value is ignored.
notification_level (NotificationLevel)
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 (Struct)
The tags for project channel.

ProjectChannelInfo #

project_channel_id (string) Required
The ID of project channel.
name (string) Required
The name of project channel
state (ProjectChannelState) Required
The state of project channel. ENABLED or DISABLED only.
data (Struct) Required
The data for using project channel.
is_subscribe (bool) Required
Indicates whether subscriptions will be used.
subscriptions (string) Repeated Required
The topic list to subscription.
is_scheduled (bool) Required
Indicates whether schedule will be used.
schedule (ProjectChannelSchedule) Required
Schedule for which you want to receive notifications through the project channel.
notification_level (NotificationLevel) Required
Set the level of notification.
tags (Struct) Required
The tags for project channel.
domain_id (string) Required
The ID of domain.
workspace_id (string) Required
The ID of workspace
project_id (string) Required
The ID of project to which the project channel belongs.
protocol_id (string) Required
The ID of protocol set in the project channel.
secret_id (string) Required
The ID of secret encrypted data in the security service
created_at (string) Required
Project channel creation time.

ProjectChannelQuery #

query (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 (ProjectChannelState)
The state of project channel. ENABLED or DISABLED only.
is_subscribe (bool)
Indicates whether subscriptions will be used.
is_scheduled (bool)
Indicates whether schedule will be used.
notification_level (NotificationLevel)
The level of notification.
project_id (string)
The ID of project to which the project channel belongs.
protocol_id (string)
The ID of protocol set in the project channel.
secret_id (string)
The ID of secret encrypted data in the security service

ProjectChannelRequest #

project_channel_id (string) Required
The ID of project channel.

ProjectChannelSchedule #

day_of_week (DayOfWeek) Repeated Required
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) Required
Start time to receive notifications. Only integer type can be set, and 0 to 23 can be.
end_hour (int32) Required
End time to receive notifications. Only integer type can be set, and 1 to 24 can be.

ProjectChannelStatQuery #

query (StatisticsQuery) Required
Statistics Query format provided by SpaceONE. Please check the link for more information.

ProjectChannelsInfo #

results (ProjectChannelInfo) Repeated Required
List of queried project channels.
total_count (int32) Required
Total counts of queried project channels.

UpdateProjectChannelRequest #

project_channel_id (string) Required
The ID of project channel.
domain_id (string) Required
The ID of domain.
name (string)
The name of Project Channel. It can have a maximum of 255 characters.
data (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 (NotificationLevel)
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 (Struct)
The tags for project channel.

UpdateProjectChannelScheduleRequest #

project_channel_id (string) Required
The ID of project channel.
is_scheduled (bool) Required
Indicates whether schedule will be used.
schedule (ProjectChannelSchedule)
Schedule for which you want to receive notifications through the project channel.

UpdateProjectChannelSubscriptionRequest #

project_channel_id (string) Required
The ID of project channel.
is_subscribe (bool) Required
Indicates whether subscriptions will be used.
subscriptions (string) Repeated
When using subscriptions, it indicates the topic list to subscription. If is_subscribe is set to false, this value is ignored.