Documentation Powered by ReDoc

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

Download OpenAPI specification:Download

URL: https://developer.ntt.com/ License: (c) 2020 NTT Communications Corporation All Rights Reserved. Terms of Service

概要

本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形式で年月を指定

limit
integer [ 1 .. 1000 ]

SIMグループ全体で見てプロファイルを最大で何件返すか。指定なしで全件返す

offset
integer >= 0
Default: 0

SIMグループ全体で見て何件目から返すか。デフォルト0

provider
string
Enum: "nttc" "tsl"

指定したプロバイダーでプロファイルを絞り込む

hsn
string

hsnに指定した文字を含むかでSIMを絞り込む

eid
string

eidに指定した文字を含むかでSIMを絞り込む

imsi
string

imsiに指定した文字を含むかでプロファイルを絞り込む

iccid
string

iccidに指定した文字を含むかでプロファイルを絞り込む

msisdn
string

msisdnに指定した文字を含むかでプロファイルを絞り込む

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
1sim 1profile 1country
Copy
 Expand all Collapse all
{
  • "sims":
    [
    ],
  • "total": 1
}

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形式で終了年月日を指定

limit
integer [ 1 .. 10000 ]

使用量一覧を最大で何件返すか。指定なしの場合、全件返す

offset
integer >= 0
Default: 0

使用量一覧全体で見て何件目から返すか。絞り込みの影響を受ける

provider
string
Enum: "nttc" "tsl"

指定したプロバイダーでプロファイルを絞り込む

hsn
string

hsnに指定した文字を含むかでSIMを絞り込む

eid
string

eidに指定した文字を含むかでSIMを絞り込む

imsi
string

imsiに指定した文字を含むかでプロファイルを絞り込む

iccid
string

iccidに指定した文字を含むかでプロファイルを絞り込む

msisdn
string

msisdnに指定した文字を含むかでプロファイルを絞り込む

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
1sim 1profile 1country
Copy
 Expand all Collapse all
{
  • "sims":
    [
    ],
  • "total": 1
}

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
boolean

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

quietWithMultiAccessStatus
boolean

trueの場合マルチアクセスSIMに絞り込んだうえでhsn,imsi,profileStatusのみを出力する

showDeletedSim
boolean

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

limit
integer [ 0 .. 10000 ]

SIMグループ全体で見てプロファイルを最大で何件返すか。指定なしで全件返す

offset
integer >= 0

SIMグループ全体で見て何件目から返すか。デフォルト0

provider
string
Enum: "nttc" "tsl"

指定したプロバイダーでプロファイルを絞り込む

esimStatus
string
Enum: "enabled" "disabled" "deleted"

指定したeSIMステータスでプロファイルを絞り込む

profileStatus
string
Enum: "inactive" "active" "suspend" "sleeping" "delete"

指定したプロファイルステータスでプロファイルを絞り込む

profileStatus_not
string
Enum: "inactive" "active" "suspend" "sleeping" "delete"

指定したプロファイルステータスを除外するようにプロファイルを絞り込む

hsn
string

hsnに指定した文字を含むかでSIMを絞り込む

eid
string

eidに指定した文字を含むかでSIMを絞り込む

orderNo
string

orderNoに指定した文字を含むかでSIMを絞り込む

imsi
string

imsiに指定した文字を含むかでプロファイルを絞り込む

iccid
string

iccidに指定した文字を含むかでプロファイルを絞り込む

msisdn
string

msisdnに指定した文字を含むかでプロファイルを絞り込む

plan
string
Enum: "payg" "fixed" "null"

指定したプランでプロファイルを絞り込む、nullで開通前などプラン未設定プロファイルに絞り込み

plan_not
string
Enum: "payg" "fixed" "null"

指定したプランを除外するようにプロファイルを絞り込む、nullで開通前などプラン未設定プロファイルのみ除外

upStream
boolean

trueの場合上り特価のみに、falseの場合上り特価以外に絞り込む

cn
boolean

trueの場合閉域のみに、falseの場合インターネット接続のみに絞り込む

icgw
boolean

trueの場合ICGW申し込み済みのみに、falseの場合ICGW申し込み前のみに絞り込む

cnActIpAddress
string

cnActIpAddressに指定した文字を含むかでプロファイルを絞り込む

cnSbyIpAddress
string

cnSbyIpAddressに指定した文字を含むかでプロファイルを絞り込む

icgwEastIpAddress
string

icgwEastIpAddressに指定した文字を含むかでプロファイルを絞り込む

icgwWestIpAddress
string

icgwWestIpAddressに指定した文字を含むかでプロファイルを絞り込む

globalStaticIpAddress
string

globalStaticIpAddressに指定した文字を含むかでプロファイルを絞り込む

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
example-1
Copy
 Expand all Collapse all
{
  • "sims":
    [
    ],
  • "total": 4
}

プロファイル残量一覧(SIMグループ別)表示用API

残量表示 > プロファイル残量 > プロファイル残量一覧 に表示するAPI プロファイル残量一覧(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
limit
integer [ 1 .. 5000 ]

SIMグループ全体で見て残量一覧を最大で何件返すか。指定なしの場合、全件返す

offset
integer >= 0
Default: 0

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}/remainUsage
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/gui/simGroups/{simGroupId}/remainUsage

Response samples

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

プロファイル一覧(シェアグループ別)表示用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":
    [
    ]
}

トランザクション詳細一覧表示API

処理状況表示 > 処理状況一覧 を表示する トランザクション一覧取得

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

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

query Parameters
status
string
Enum: "success" "processing" "failed" "cancel" "all"
Example: status=success

success, processing, failed, cancel, allで絞り込み, 指定がない場合は全て表示

type
string
Enum: "changePlan" "changeLimit" "deleteProfile" "enableProfile" "switchProfile" "sleepProfile" "wakeProfile" "orderProfile" "terminateSim" "downloadProfile" "orderSim" "deactiveSim" "reactiveSim" "auditEsim" "changeProfileCnIpAddress" "cancelChangePlan" "connectCn" "enableIcgw" "profileShareGroupModify" "addLimit"
Example: type=changePlan

transaction typeで絞り込み, 指定がない場合は全て表示

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

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

Responses

200

OK

400

Bad Request

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

Response samples

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

シェアグループ表示API

リソース管理 > SIM管理 > グループ一覧 を表示するための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}/gui/shareGroups
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/gui/shareGroups

Response samples

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

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

使用量表示 > グループ一覧 > シェアグループ 月別使用量に表示するAPI シェアグループ使用量 (年月日指定) 一覧取得

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

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

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

shareGroupに一意に与えられるID

query Parameters
startMonth
required
string ^\d{4}-\d{2}$
Example: startMonth=2021-01

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

endMonth
required
string ^\d{4}-\d{2}$
Example: endMonth=2021-03

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/shareGroups/{shareId}/monthlyUsage
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/gui/shareGroups/{shareId}/monthlyUsage

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shareLimit": 20000000,
  • "shareUpLimit": null,
  • "monthlyShareUsage":
    [
    ]
}

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

使用量表示 > グループ一覧 > シェアグループ 日別使用量に表示するAPI シェアグループ使用量 (年月日指定) 一覧取得

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

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

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

shareGroupに一意に与えられる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/shareGroups/{shareId}/dailyUsage
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/gui/shareGroups/{shareId}/dailyUsage

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shareLimit": 20000000,
  • "shareUpLimit": null,
  • "dailyShareUsage":
    [
    ]
}