Documentation Powered by ReDoc

ALERTS - IoT Connect Mobile Type S リファレンス (2.0.0)

Download OpenAPI specification:Download

URL: https://developer.ntt.com/ License: © 2020 NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

概要

本APIでは、IoT Connect Mobile Type S に関するリソースの参照・操作が可能です。

Alert

Alert に関連する API

閾値超えアラート送付用メールアドレス参照API

閾値超えアラート送付用メールアドレス参照API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/alerts/mailAddress
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/alerts/mailAddress

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "alertMailAddress": "alert-notification@example.org"
}

閾値超えアラート送付用メールアドレス変更API

閾値超えアラート送付用メールアドレス登録・変更API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
alertMailAddress
required
string <email>

閾値超えアラート送付用メールアドレス

Responses

200

OK

400

Bad Request

put/tenants/{tenantId}/alerts/mailAddress
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/alerts/mailAddress

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "alertMailAddress": "alert-notification@example.org"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestBody":
    {
    }
}

閾値超えアラート送付用メールアドレス削除API

閾値超えアラート送付用メールアドレス削除API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Responses

204

No Content

400

Bad Request

delete/tenants/{tenantId}/alerts/mailAddress
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/alerts/mailAddress

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "message": "Bad Request",
  • "detail": "path parameter 'tenantId' is invalid"
}