docomo business SIGN 共通APIリファレンス (1.0.0)

Download OpenAPI specification:

docomo business SIGN 共通APIリファレンス

SIM送付先

SIMの送付先を管理するAPI

送付先住所一覧取得

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

200
400

Content type

application/json

{"shippingAddresses": [{"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd",
"contractorName": "山田　太郎",
"shippingPostalCode": "100-8019",
"shippingPrefecture": "東京都",
"shippingCity": "千代田区",
"shippingCityAdditionalInfo": "string",
"shippingAddress": "大手町2-3-1",
"shippingBuilding": "大手町プレイスウエストタワー",
"packageRecipient": "開発部",
"packageRecipientCompany": "エヌ・ティ・ティ・コミュニケーションズ",
"phoneNumber": "03-1234-1234",
"contractorEmailAddress": "test@example.com"
}
]
}

送付先住所登録

送付先住所登録
作成可能件数: 10件

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

contractorName required	string 契約者氏名
shippingPostalCode required	string 宛先郵便番号
shippingPrefecture required	string <= 4 characters 宛先都道府県
shippingCity required	string <= 12 characters 宛先市区町村
shippingCityAdditionalInfo required	string or null <= 16 characters 宛先大字通称など
shippingAddress required	string <= 16 characters 宛先町番地
shippingBuilding required	string <= 16 characters 宛先ビル名等
packageRecipient required	string <= 16 characters 部署名・担当者名
packageRecipientCompany required	string or null <= 16 characters 発送先会社名
phoneNumber required	string 宛先電話番号
contractorEmailAddress required	string <email> <= 254 characters ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.... 契約者メールアドレス

Responses

Request samples

Payload

Content type

application/json

{"contractorName": "string",
"shippingPostalCode": "string",
"shippingPrefecture": "stri",
"shippingCity": "string",
"shippingCityAdditionalInfo": "string",
"shippingAddress": "string",
"shippingBuilding": "string",
"packageRecipient": "string",
"packageRecipientCompany": "string",
"phoneNumber": "string",
"contractorEmailAddress": "user@example.com"
}

Response samples

201
400

Content type

application/json

{"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd",
"contractorName": "山田　太郎",
"shippingPostalCode": "100-8019",
"shippingPrefecture": "東京都",
"shippingCity": "千代田区",
"shippingCityAdditionalInfo": "string",
"shippingAddress": "大手町2-3-1",
"shippingBuilding": "大手町プレイスウエストタワー",
"packageRecipient": "開発部",
"packageRecipientCompany": "エヌ・ティ・ティ・コミュニケーションズ",
"phoneNumber": "03-1234-1234",
"contractorEmailAddress": "test@example.com"
}

送付先住所取得

path Parameters

tenantId required	string = 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
shippingAddressId required	string = 32 characters 0-9a-f Example: b41715e07684453abbe8a83eb93fde80 送付先住所ID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

200
400
404

Content type

application/json

{"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd",
"contractorName": "山田　太郎",
"shippingPostalCode": "100-8019",
"shippingPrefecture": "東京都",
"shippingCity": "千代田区",
"shippingCityAdditionalInfo": "string",
"shippingAddress": "大手町2-3-1",
"shippingBuilding": "大手町プレイスウエストタワー",
"packageRecipient": "開発部",
"packageRecipientCompany": "エヌ・ティ・ティ・コミュニケーションズ",
"phoneNumber": "03-1234-1234",
"contractorEmailAddress": "test@example.com"
}

送付先住所変更

path Parameters

tenantId required	string = 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
shippingAddressId required	string = 32 characters 0-9a-f Example: b41715e07684453abbe8a83eb93fde80 送付先住所ID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Request Body schema: application/json

contractorName required	string 契約者氏名
shippingPostalCode required	string 宛先郵便番号
shippingPrefecture required	string <= 4 characters 宛先都道府県
shippingCity required	string <= 12 characters 宛先市区町村
shippingCityAdditionalInfo required	string or null <= 16 characters 宛先大字通称など
shippingAddress required	string <= 16 characters 宛先町番地
shippingBuilding required	string <= 16 characters 宛先ビル名等
packageRecipient required	string <= 16 characters 部署名・担当者名
packageRecipientCompany required	string or null <= 16 characters 発送先会社名
phoneNumber required	string 宛先電話番号
contractorEmailAddress required	string <email> <= 254 characters ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.... 契約者メールアドレス

Responses

Request samples

Payload

Content type

application/json

{"contractorName": "string",
"shippingPostalCode": "string",
"shippingPrefecture": "stri",
"shippingCity": "string",
"shippingCityAdditionalInfo": "string",
"shippingAddress": "string",
"shippingBuilding": "string",
"packageRecipient": "string",
"packageRecipientCompany": "string",
"phoneNumber": "string",
"contractorEmailAddress": "user@example.com"
}

Response samples

200
400
404

Content type

application/json

{"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd",
"contractorName": "山田　太郎",
"shippingPostalCode": "100-8019",
"shippingPrefecture": "東京都",
"shippingCity": "千代田区",
"shippingCityAdditionalInfo": "string",
"shippingAddress": "大手町2-3-1",
"shippingBuilding": "大手町プレイスウエストタワー",
"packageRecipient": "開発部",
"packageRecipientCompany": "エヌ・ティ・ティ・コミュニケーションズ",
"phoneNumber": "03-1234-1234",
"contractorEmailAddress": "test@example.com"
}

送付先住所削除

path Parameters

tenantId required	string = 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
shippingAddressId required	string = 32 characters 0-9a-f Example: b41715e07684453abbe8a83eb93fde80 送付先住所ID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

400
404

Content type

application/json

Example

example-iotneoError

{"errorCode": 10104,
"errorMessages": ["path parameter 'hsn' is invalid"
]
}

オーダー管理

オーダー管理用API

オーダー履歴一覧取得

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

from required	string <date> Example: from=2024-06-10 検索年月日(from)　検索年月日(to)以前であること。 fromパラメータに指定された日付の午前0時00分00秒以降のデータを取得対象とします。
to required	string <date> Example: to=2024-06-10 検索年月日(to)　検索年月日(from)以降であること。 toパラメータに指定された日付の23時59分59秒までのデータを取得対象とします。
serviceType	string (serviceType) Enum: "mvno-open" "mvno-closed" "things-cloud" "fic" "maxiv" "skyway" "security" "mno" "icgwonmec" "applet" "iaas" サービスタイプ
orderType	string (orderType) Enum: "create-sim" "suspend" "resume" "delete-sim" "policy" "activate" "sleep" "wake" "add-limit" "create-connection" "delete-connection" "create-tc" "delete-tc" "request-approval" "execute-request" "delete-request" "create-maxiv" "delete-maxiv" "create-skyway" "delete-skyway" "create-rink-help-desk" "delete-rink-help-desk" "start-rink-flow-collector" "end-rink-flow-collector" "create-mno-fic" "delete-mno-fic" "start-mno-rink-flow-collector" "end-mno-rink-flow-collector" "create-sim-group" "sim-move" "create-mec-gw" "delete-mec-gw" "create-icgwonmec" "delete-icgwonmec" "create-applet" "delete-applet" "create_iaas" "create_volume" "delete_iaas" "delete_volume" "attach-volume" "detach-volume" オーダータイプ（複数指定可能） `create-sim: SIM発注` `suspend: SIM利用中断` `resume: SIM利用再開` `delete-sim: SIM廃止` `policy: 料金プラン変更/上限値変更` `activate: プロファイル開通` `sleep: プロファイル利用休止` `wake: プロファイル休止解除` `add-limit: 容量追加` `create-connection: NTTC閉域接続申し込み` `delete-connection: NTTC閉域契約廃止` `create-tc: CREATE_ORDER` `delete-tc: DELETE_ORDER` `request-approval: 接続承認依頼` `execute-request: オーダー実行` `delete-request: FIC-Connection廃止` `create-maxiv: MAXIV契約` `delete-maxiv: MAXIV解約` `create-skyway: SkyWay契約` `delete-skyway: SkyWay解約` `create-rink-help-desk: ヘルプデスク設定` `delete-rink-help-desk: ヘルプデスク廃止` `start-rink-flow-collector: フローコレクター利用開始` `end-rink-flow-collector: フローコレクター利用停止` `create-mno-fic: FIC-Connection作成(MNO)` `delete-mno-fic: FIC-Connection廃止(MNO)` `start-mno-rink-flow-collector: フローコレクター利用開始(MNO)` `end-mno-rink-flow-collector: フローコレクター利用停止(MNO)` `create-sim-group: SIMグループ作成` `sim-move: SIMグループ間移動` `create-mec-gw: MEC-GW作成` `delete-mec-gw: MEC-GW廃止` `create-icgwonmec: ICGWonMEC基盤作成` `delete-icgwonmec: ICGWonMEC基盤廃止` `create-applet: アプレット契約` `delete-applet: アプレット契約解約` `create_iaas: IaaSサーバー作成` `create_volume: ボリューム作成` `delete_iaas: IaaSサーバー削除` `delete_volume: ボリューム削除` `attach-volume: ボリューム接続` `detach-volume: ボリューム切断`
page	integer >= 1 Example: page=3 ページ数. デフォルトは1
pageSize	integer [ 1 .. 10000 ] Example: pageSize=30 1ページ中のアイテム数. デフォルトは20

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

200
400

Content type

application/json

{"orders": [{"orderId": "string",
"serviceType": "mvno-open",
"orderType": "create-sim",
"orderedAt": null
}
],
"total": 1,
"totalPages": 5,
"page": 1,
"pageSize": 20
}

オーダー履歴取得

path Parameters

tenantId required	string = 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
orderId required	string^[0-9a-f]{32}$ Example: e4eaaaf2d14211e1b3e4080027620cdd docomo business SIGNで管理するオーダーID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

200
400
404

Content type

application/json

{"serviceType": "mvno-open",
"orderType": "create-sim",
"orderedAt": "2024-06-10T06:30:30Z",
"status": "success",
"updatedAt": "2024-06-10T06:30:30Z",
"endedAt": "2024-06-10T06:30:30Z"
}

ダッシュボード

トップページ用API

ダッシュボード用の申込件数取得API

ダッシュボード用の申込件数取得

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

targetCollection

string

Enum: "simsCount" "threatsCount" "trafficsCount" "paasCount" "flowCollector" "interConnect"

ダッシュボードで取得する集計種別

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

200
400

Content type

application/json

Example

Queryパラメーターなしの場合

{"simsCount": {"open": 1000,
"closed": 100,
"mec": 150
},
"threatsCount": {"critical": 1,
"high": 1,
"medium": 2,
"other": 3,
"low": 10,
"informational": 10
},
"trafficsCount": {"critical": 1,
"high": 1,
"other": 10
},
"paasCount": {"mec": 2,
"cloud": 3
},
"contents": {"security": {"threat": true,
"flowCollector": true
},
"mobileNetwork": {"open": true,
"closed": true,
"mec": true
},
"application": {"iotService": true,
"mecService": true
},
"interConnect": {"remoteAccess": true,
"cloudService": true,
"networkService": true
}
}
}

約款

約款同意状況管理用API

約款同意状況取得

最新の約款バージョンと同意状況を返却

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

200
400

Content type

application/json

{"urls": ["https://host/1111",
"https://host/2222"
],
"isAgreed": true
}

約款同意

現在施行中の最新の約款に同意する

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

200
400

Content type

application/json

{"isAgreed": true
}