Documentation Powered by ReDoc

SIM Group - IoT Connect Mobile Type S API リファレンス (3.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 に関するリソースの参照・操作が可能です。

SIM Group

SIM一覧(SIMグループ内)参照API

SIMグループ内に所属するSIM(HSN)一覧を参照するAPI

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

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

simGroupId
required
string <uuid>
Example: eea3cd65-1921-4999-bbd7-94f4a4066629

SIMグループ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}/simGroups/sims/{simGroupId}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/simGroups/sims/{simGroupId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    },
  • {
    }
]

SIMグループ間のSIM移動API

SIM(HSN)の所属SIMグループを移動するAPI

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

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

simGroupId
required
string <uuid>
Example: eea3cd65-1921-4999-bbd7-94f4a4066629

SIMグループID

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

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

Request Body schema: application/json

SIM移動APIのリクエストBody

simGroupId
required
string <uuid>

SIMグループID

hsn
required
string ^[0-9A-F]{10}$

ハードウェアシリアル番号(HSN)

Responses

204

No Content

400

Bad Request

post/tenants/{tenantId}/simGroups/sims/{simGroupId}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/simGroups/sims/{simGroupId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "simGroupId": "eea3cd65-1921-4999-bbd7-94f4a4066629",
  • "hsn": "013AAA0027"
}

Response samples

Content type
application/json
Example
pathに含まれる値が存在しない場合
Copy
 Expand all Collapse all
{
  • "message": "Bad Request",
  • "detail": "path parameter 'simGroupId' is invalid"
}

SIMグループ一覧参照API

自テナント内に存在するSIMグループ名/SIMグループIDを参照する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}/simGroups/self-only
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/simGroups/self-only

Response samples

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

SIMグループ新規作成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

Request Body schema: application/json

SIMグループ新規作成APIのリクエストBody

simGroupName
required
string

SIMグループ名

Responses

204

No Content

400

Bad Request

post/tenants/{tenantId}/simGroups/self-only
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/simGroups/self-only

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "simGroupName": "グループA"
}

Response samples

Content type
application/json
Example
pathに含まれる値が存在しない場合
Copy
 Expand all Collapse all
{
  • "message": "Bad Request",
  • "detail": "path parameter 'tenantId' is invalid"
}

SIMグループ情報参照API

SIMグループの情報を参照するAPI

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

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

simGroupId
required
string <uuid>
Example: eea3cd65-1921-4999-bbd7-94f4a4066629

SIMグループ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}/simGroups/self-add/{simGroupId}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/simGroups/self-add/{simGroupId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "simGroupId": "e90713c2-9864-4d2e-b6df-4fa9bbb5067a",
  • "simGroupName": "default"
}

SIMグループ更新API

SIMグループの情報を更新するAPI

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

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

simGroupId
required
string <uuid>
Example: eea3cd65-1921-4999-bbd7-94f4a4066629

SIMグループID

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

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

Request Body schema: application/json

SIMグループ更新APIのリクエストBody

simGroupName
required
string

SIMグループ名

simGroupId
required
string <uuid>

SIMグループID (uuid)

Responses

204

No Content

400

Bad Request

put/tenants/{tenantId}/simGroups/self-add/{simGroupId}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/simGroups/self-add/{simGroupId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "simGroupName": "default",
  • "simGroupId": "eea3cd65-1921-4999-bbd7-94f4a4066629"
}

Response samples

Content type
application/json
Example
pathに含まれる値が存在しない場合
Copy
 Expand all Collapse all
{
  • "message": "Bad Request",
  • "detail": "path parameter 'simGroupId' is invalid"
}

SIMグループ削除API

SIMグループを削除するAPI

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

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

simGroupId
required
string <uuid>
Example: eea3cd65-1921-4999-bbd7-94f4a4066629

SIMグループID

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

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

Responses

204

No Content

400

Bad Request

409

Conflict

delete/tenants/{tenantId}/simGroups/self-add/{simGroupId}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/simGroups/self-add/{simGroupId}

Response samples

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