Documentation Powered by ReDoc

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

Share Group

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

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

shareName
required
string

シェアグループ名

shareClass
required
any
Enum: "fixed_internet" "fixed_cn" "upstream_internet" "upstream_cn"

シェアグループクラス(fixed_internet:定額プラン_インターネット接続, fixed_cn:定額プラン_NTTC閉域接続, upstream_internet:上り特価プラン_インターネット接続, upstream_cn:上り特価プラン_NTTC閉域接続)

Responses

204

No Content

400

Bad Request

post/tenants/{tenantId}/shareGroups
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/shareGroups

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "shareName": "グループA",
  • "shareClass": "fixed_internet"
}

Response samples

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

シェアグループ更新API

シェアグループの情報を更新するAPI

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

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

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

shareGroupに一意に与えられるID

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

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

Request Body schema: application/json

シェアグループ更新APIのリクエストBody

shareName
required
string

シェアグループ名

Responses

204

No Content

400

Bad Request

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

Request samples

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

Response samples

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

シェアグループ削除API

シェアグループを削除するAPI

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

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

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

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

Response samples

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

プロファイル一覧(シェアグループ内)参照API

シェアグループ内に所属するプロファイル(IMSI)一覧を参照するAPI

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

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

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

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

Response samples

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

プロファイルのシェアグループ所属申込みAPI

プロファイル(IMSI)のシェアグループ所属を申込みをするAPI

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

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

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

shareGroupに一意に与えられるID

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

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

Request Body schema: application/json

プロファイルのシェアグループ所属申込みAPIのリクエストBody

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

Responses

200

OK

202

Accepted

400

Bad Request

409

Conflict

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tid": "tran-sdp-20210101-000000-0001",
  • "requestBody":
    {
    }
}

プロファイルのシェアグループ所属解除API

プロファイル(IMSI)のシェアグループ所属を解除するAPI

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

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

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

shareGroupに一意に与えられるID

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

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

Request Body schema: application/json

プロファイル(IMSI)のシェアグループ所属を解除するAPI リクエストBody

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

Responses

200

Accepted

400

Bad Request

409

Conflict

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

Request samples

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

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

orderId
required
string ^tran-sdp-[0-9]{8}-[0-9]{6}-[0-9]{4}$
Example: tran-sdp-20210101-000000-0001

orderId(プロファイルのシェアグループ所属申込みAPIのトランザクション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}/shareGroupOrder/{orderId}
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/shareGroupOrder/{orderId}

Response samples

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