API docs by Redocly

docomo business SIGN Things Cloud APIリファレンス (1.0.0)

Download OpenAPI specification:

URL: https://sdpf.ntt.com License: NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

docomo business SIGN Things Cloud APIリファレンス

Order

Order API

Things Cloud契約

テナントに紐付くオーダー情報とTC親テナントを作成

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json
required

作成するオーダーとTC親テナントの情報

adminEmail
required
string <email> (adminEmail) <= 254 characters ^(?:[-!#-'*+/-9=?A-Z^-~]+(?:\.[-!#-'*+/-9=?A-...

管理者メールアドレス

adminName
required
string (adminName) <= 50 characters ^[^\s/\\+:$]+$

管理者ID

domain
required
string (domain) <= 256 characters ^[a-z0-9]+(-[a-z0-9]+)*\.(iot-trialpack.com|j...

TCドメイン

pricePlan
required
string (pricePlan)
Enum: "standard" "economy" "super-economy"

料金プラン

tenantGrade
required
string (tenantGrade)
Enum: "basic" "advanced" "enterprise"

テナントグレード

Responses

Request samples

Content type
application/json
{
  • "adminEmail": "sampleAdmin@example.com",
  • "adminName": "sampleAdminName",
  • "domain": "sample-domain.je1.thingscloud.ntt.com",
  • "pricePlan": "standard",
  • "tenantGrade": "basic"
}

Response samples

Content type
application/json
{
  • "adminEmail": "sampleAdmin@example.com",
  • "adminName": "sampleAdminName",
  • "domain": "sample-domain.je1.thingscloud.ntt.com",
  • "company": "143cf838ec7f4bc692408c35a2d2e755",
  • "pricePlan": "standard",
  • "tenantGrade": "basic",
  • "options": {
    },
  • "endTime": "",
  • "tenantStatus": "",
  • "operationStatus": "IN_PROGRESS",
  • "operationTime": "2022-08-06T12:03:27.845Z",
  • "operationId": "493274320",
  • "orderType": "CREATE_ORDER"
}

Things Cloud契約取得

テナントに紐づくTC親テナントのオーダー情報を取得

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "adminEmail": "sampleAdmin@example.com",
  • "adminName": "sampleAdminName",
  • "domain": "sample-domain.je1.thingscloud.ntt.com",
  • "company": "143cf838ec7f4bc692408c35a2d2e755",
  • "pricePlan": "standard",
  • "tenantGrade": "basic",
  • "options": {
    },
  • "endTime": "",
  • "tenantStatus": "ACTIVE",
  • "operationStatus": "SUCCEEDED",
  • "operationTime": "2022-08-17T10:15:30.845Z",
  • "operationId": "493274321",
  • "orderType": "CREATE_ORDER"
}

Things Cloud解約

TC親テナントを廃止する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "adminEmail": "sampleAdmin@example.com",
  • "adminName": "sampleAdminName",
  • "domain": "sample-domain.je1.thingscloud.ntt.com",
  • "company": "143cf838ec7f4bc692408c35a2d2e755",
  • "pricePlan": "standard",
  • "tenantGrade": "basic",
  • "options": {
    },
  • "endTime": "",
  • "tenantStatus": "ACTIVE",
  • "operationStatus": "IN_PROGRESS",
  • "operationTime": "2022-08-17T12:03:27.845Z",
  • "operationId": "493274323",
  • "orderType": "DELETE_ORDER"
}