1.2.8 メール通知先

機能

メールアドレス設定の表示

処理概要

メールアドレスの設定情報を表示します。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

データを格納するキー名: mail_address
単一のオブジェクトを返却

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード	キー	説明	表示	形式
200	to_address_1	通知先1のメールアドレス	Yes	string
	to_address_2	通知先2のメールアドレス	Yes	string
	to_address_3	通知先3のメールアドレス	Yes	string

1.2.8.2 PUT /v1/mail/address

機能

メールアドレスの設定

処理概要

メールアドレスの設定をします。

実行ユーザーが“Monitor”ロールの場合は、実行できません。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query
to_address_1	通知先1のメールアドレスを指定します。最大文字数: 63 設定を削除する場合は、空文字列("")を指定します。 [例] user01@example.com	任意	string	query
to_address_2	通知先2のメールアドレスを指定します。最大文字数: 63 設定を削除する場合は、空文字列("")を指定します。 [例] user02@example.com	任意	string	query
to_address_3	通知先3のメールアドレスを指定します。最大文字数: 63 設定を削除する場合は、空文字列("")を指定します。 [例] user03@example.com	任意	string	query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

データを格納するキー名: mail_address
以下の値のうち、パラメーターとして指定された値を単一のオブジェクトとして返却

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード	キー	説明	形式
200	to_address_1	通知先1のメールアドレス	string
	to_address_2	通知先2のメールアドレス	string
	to_address_3	通知先3のメールアドレス	string

1.2.8.3 POST /v1/mail/address/test

機能

テストメール送信

処理概要

テストメールを送信します。

実行ユーザーが“Monitor”ロールの場合は、実行できません。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

データを格納するキー名: mail_address
単一のオブジェクトを返却

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード	キー	説明	形式
200	to_address_1	通知先1のメールアドレス	string
	to_address_2	通知先2のメールアドレス	string
	to_address_3	通知先3のメールアドレス	string