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

Download OpenAPI specification:Download

概要

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

gui

gui画面に表示する API

Profile Usage (年月指定) 一覧表示用 API

使用量表示 > グループ一覧 > SIMグループ 月別使用 に表示するAPI プロファイル使用量 (年月指定)一覧取得

path Parameters
tenantId
required
string ^[\da-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

simGroupId
required
string ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
Example: eea3cd65-1921-4999-bbd7-94f4a4066629

SIMグループID

query Parameters
date
required
string ^\d{4}-\d{2}$
Example: date=2020-08

yyyy-MM形式で年月を指定

header Parameters
X-Auth-Token
required
string ^[\da-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

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

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/gui/simGroups/{simGroupId}/monthlyUsage
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/gui/simGroups/{simGroupId}/monthlyUsage

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "sims":
    [
    ]
}

Profile Usage (年月日指定) 一覧表示用 API

使用量表示 > グループ一覧 > SIMグループ 日別使用量 に表示するAPI プロファイル使用量 (年月日指定) 一覧取得

path Parameters
tenantId
required
string ^[\da-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

simGroupId
required
string ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
Example: eea3cd65-1921-4999-bbd7-94f4a4066629

SIMグループID

query Parameters
startDate
required
string ^\d{4}-\d{2}-\d{2}$
Example: startDate=2021-02-04

yyyy-MM-dd形式で開始年月日を指定

endDate
required
string ^\d{4}-\d{2}-\d{2}$
Example: endDate=2021-02-06

yyyy-MM-dd形式で終了年月日を指定

header Parameters
X-Auth-Token
required
string ^[\da-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

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

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/gui/simGroups/{simGroupId}/dailyUsage
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/gui/simGroups/{simGroupId}/dailyUsage

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "sims":
    [
    ]
}

SIM一覧(SIMグループ別)表示用API

リソース管理 > SIM管理 > グループ一覧 > SIMグループ SIM一覧 に表示するAPI SIM(SIMグループ別)一覧取得

path Parameters
tenantId
required
string ^[\da-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

simGroupId
required
string ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
Example: eea3cd65-1921-4999-bbd7-94f4a4066629

SIMグループID

query Parameters
quiet
string ^(true)$

trueの場合hsn,imsiのみを出力する

showDeletedSim
string ^(true)$

trueの場合削除済みSIMも含める

header Parameters
X-Auth-Token
required
string ^[\da-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

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

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/gui/simGroups/{simGroupId}/sims
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/gui/simGroups/{simGroupId}/sims

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "sims":
    [
    ]
}

プロファイル一覧(シェアグループ別)表示用API

リソース管理 > SIM管理 > グループ一覧 > シェアグループ SIM一覧 に表示するAPI Profile(シェアグループ別)一覧取得

path Parameters
tenantId
required
string ^[\da-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

shareId
required
string ^[0-9]{1,9}$
Example: 1234567

shareGroupに一意に与えられるID

header Parameters
X-Auth-Token
required
string ^[\da-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

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

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/gui/shareGroups/{shareId}/profiles
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/gui/shareGroups/{shareId}/profiles

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "sims":
    [
    ]
}

SIM利用状況表示API

リソース管理 > SIM管理 > グループ一覧 を表示するためのAPI SIM利用状況取得. 廃止済のSIMやグループは除く

path Parameters
tenantId
required
string ^[\da-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

header Parameters
X-Auth-Token
required
string ^[\da-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

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

Responses

200

OK

400

Bad Request

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

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "groups":
    [