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

Download OpenAPI specification:Download

概要

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

transactions

Transactionに関する API

Transaction詳細参照API

Transaction 詳細を参照するAPI

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

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

id
required
string
Example: ORDER-20200807-0919

SIM発注番号

query Parameters
status
string ^(success|processing|failed|cancel|all)
Enum: "success" "processing" "failed" "cancel" "all"
Example: status=processing

トランザクションステータス success, processing, failed, cancel, allで絞り込み 指定がない場合は全て表示

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

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

Responses

200

OK

400

Bad Request

404

Not Found

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

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "transactionStatus": "success",
  • "transactionType": "enableProfile",
  • "transactionStartedAt": "2021-01-04 08:24:59",
  • "transactionUpdatedAt": "2021-01-04 09:08:55",
  • "transactionEndedAt": "2021-01-04 09:08:55",
  • "detail":
    {
    }
}

TransactionキャンセルAPI(月またぎplan変更のみキャンセル可)

TransactionキャンセルAPI(月またぎplan変更のみキャンセル可)

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

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

id
required
string
Example: ORDER-20200807-0919

SIM発注番号

header Parameters
X-Auth-Token
required
string

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

Responses

202

Accepted

400

Bad Request

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

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "tid": "string",
  • "requestBody":
    {
    }
}