Share Groups - IoT Connect Mobile Type S API リファレンス (2.0.0)
Download OpenAPI specification:Download
シェアグループ新規作成API
シェアグループを新規に作成するAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
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 | string Enum: "fixed_internet" "fixed_cn" "upstream_internet" "upstream_cn" シェアグループクラス(fixed_internet:定額プラン_インターネット接続, fixed_cn:定額プラン_閉域接続, upstream_internet:上り特価プラン_インターネット接続, upstream_cn:上り特価プラン_閉域接続) |
Responses
No Content
Bad Request
Request samples
- Payload
{- "shareName": "グループA",
- "shareClass": "fixed_internet"
}
Response samples
- 400
{- "message": "Bad Request",
- "detail": "path parameter 'tenantId' is invalid"
}
シェアグループ削除API
シェアグループを削除するAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
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
No Content
Bad Request
Response samples
- 400
{- "message": "Bad Request",
- "detail": "path parameter 'shareId' is invalid"
}
シェアグループ更新API
シェアグループの情報を更新するAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
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
No Content
Bad Request
Request samples
- Payload
{- "shareName": "グループB"
}
Response samples
- 400
{- "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. UUID 形式 |
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
OK
Bad Request
Response samples
- 200
- 400
[- {
- "imsi": "440130000096015"
}, - {
- "imsi": "440130000096016"
}, - {
- "imsi": "440130000096017"
}
]
プロファイルのシェアグループ所属申込みAPI
プロファイル(IMSI)のシェアグループ所属を申込みをするAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
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 <= 15 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
Responses
OK
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "imsi": "440130000096015"
}
Response samples
- 200
- 202
- 400
- 409
{- "tid": "tran-sdp-20210101-000000-0001",
- "requestBody": {
- "imsi": "440130000096015"
}
}
プロファイルのシェアグループ所属解除API
プロファイル(IMSI)のシェアグループ所属を解除するAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
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 <= 15 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "imsi": "440130000096015"
}
Response samples
- 200
- 400
- 409
{- "requestBody": {
- "imsi": "440130000096015"
}
}
プロファイルのシェアグループ所属申込み取り消しAPI
プロファイルのシェアグループ所属申込みを取り消すAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
orderId required | string tran-sdp-\d{8}-\d{6}-\d{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
No Content
Bad Request
Response samples
- 400
{- "message": "Bad Request",
- "detail": "path parameter 'orderId' is invalid"
}