IoT Connect Gateway SDP APIリファレンス (1.0.0)

Download OpenAPI specification:Download

IoT Connect Gateway SDP APIリファレンス

SIM

デバイス管理のSIMに関するAPI

SIMの一覧情報を取得する

SIMの一覧情報を取得する

path Parameters
tenantId
required
string ^[0-9a-fA-F]{32}$

テナントID

query Parameters
imsi
string
Example: imsi=dummy_imsi

検索に使うIMSI(部分一致)

imei
string
Example: imei=NA

検索に使うIMEI(部分一致)

msisdn
string
Example: msisdn=NA

検索に使うMSISDN(部分一致)

deviceName
string
Example: deviceName=dummy_device_name

検索に使うデバイス名(部分一致)

ipAddress
string <ipv4>
Example: ipAddress=dummy_ip_address

検索に使うIPアドレス(部分一致)

systemId
string
Example: systemId=dummy_system_id

検索に使うシステムID(部分一致)

mqttClientId
string
Example: mqttClientId=dummy_mqtt_client_id

検索に使うMQTTクライアントID(部分一致)

hsn
string
Example: hsn=dummy_hsn

検索に使うHSN(部分一致)

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

azureDeviceId
string
Example: azureDeviceId=dummy_azure_device_id

検索に使うAzureデバイスID(部分一致)

gcpDeviceId
string
Example: gcpDeviceId=dummy_gcp_device_id

検索に使うGCPデバイスID(部分一致)

standardDeviceId
string
Example: standardDeviceId=dummy_standard_device_id

検索に使うスタンダードデバイスID(部分一致)

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/sims
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/sims

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "sims":
    [
    ]
}

SIMの詳細情報を取得する

SIMの詳細情報を取得する

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

テナントID

imsi
required
string
Example: dummy_imsi

IMSI

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/sims/{imsi}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/sims/{imsi}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "imsi": "dummy_imsi",
  • "imei": "NA",
  • "msisdn": "NA",
  • "deviceName": "dummy_device_name",
  • "ipAddresses":
    [
    ],
  • "groupId": "dummy_group_id",
  • "systemId": "dummy_system_id",
  • "mqttClientId": "dummy_mqtt_client_id",
  • "azureDeviceId": "dummy_azure_device_id",
  • "gcpDeviceId": "dummy_gcp_device_id",
  • "standardDeviceId": "dummy_standard_device_id",
  • "hsn": "dummy_hsn",
  • "activation": true,
  • "optionData1": "NA",
  • "optionData2": "NA",
  • "optionData3": "NA",
  • "description": "dummy_sim",
  • "appletInfo":
    {
    }
}

SIMを更新する

SIMを更新する

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

テナントID

imsi
required
string
Example: dummy_imsi

IMSI

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
  • imei、msisdn、deviceName、optionData1、optionData2、optionData3がnullの場合はNAが自動的に入力される
imei
string [ 1 .. 15 ] characters ^[0-9]+$

IMEI

msisdn
string [ 1 .. 15 ] characters ^[0-9]+$

MSISDN

deviceName
string <= 100 characters ^\S*$

デバイス名 (空白類文字列は含められない)

groupId
string ^[0-9a-f]{24}$

グループID

systemId
string <= 10 characters

システムID

mqttClientId
string <= 24 characters

MQTTクライアントID

azureDeviceId
string <= 24 characters

AzureデバイスID

gcpDeviceId
string <= 24 characters

GCPデバイスID

standardDeviceId
string <= 24 characters

スタンダードデバイスID

optionData1
string <= 256 characters

予備

optionData2
string <= 256 characters

予備

optionData3
string <= 256 characters

予備

description
string <= 200 characters

説明

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/sims/{imsi}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/sims/{imsi}

Request samples