Arcstar Universal One API

Overview

 ■ Users can use Arcstar Universal One APIs as below.
  (For Japan domestic line only)

  ・Arcstar Universal One Contract Detail API
  ・Arcstar Universal One Traffic Info API
  ・Arcstar Universal One Circuit Alarm API
  ・Arcstar Universal One Planned Outage Info API(Guarantee Plan)
   - Planned Outage List API
   - Planned Outage Detail Info API
  ・Arcstar Universal One Planned Outage Info API(Best Effort Plan)
  ・Arcstar Universal One Monitoring Suspension API
   ‐ Monitoring Suspension Info API
   ‐ Monitoring Suspension Register API
   ‐ Monitoring Suspension Update API
   ‐ Monitoring Suspension Delete API
  
 ■ Notice

  To use this API, users need to send mail to Support (https://developer.ntt.com/ja/contact.html) including below information.
If you don't have Developer Portal account, please fill in 【Comments/Question】.

 【Required information】
   - User information(Company name, Devision, Contact person)
   - Start date of use
   - Purpose of use
   - Contact info (e.g phone number, e-mail,etc..)

  ※The person in charge of corresponding service will contact you.

Resource URL

 Please use global common domain or individual region domain as below.
 If you want to use the global common domain, depending on the circumstances of your available points, your request connect to the nearest API gateway.1

1.Base Path(Global Load Balance)

https://api.ntt.com/v2/uno

2.Base Path(Region)

https://{region}.api.ntt.com/v2/uno
  • region is jp|us|uk
  • e.g. https://us.api.ntt.com/v2/uno
  • Specifiable regions will be expanded in the future

Resource Information  

Key Value
Response format JSON
Authentication(OAuth) YES
Bandwidth control #1 YES

Contract Detail

 By using this API, you can get detail information of Contract data of Arcstar Universal One filtered by VPN group ID and service contract ID in JSON format.

  • Applicable to Japan domestic line only.

To get the Contract information

GET /v2/uno/contracts/{vpnGroupId}/{contractId} 

Request Parameters

Name Description Type Mandatory
vpnGroupId VPN group ID
e.g. 'V'+8 digit number
path variable Yes
contractId Service contract ID
e.g. 'N'+9 digit number
path variable Yes

Example Request

Content-Type: 
Host: api.ntt.com  
GET /v2/uno/contracts/V12345678/N123456789 
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* For details on acquiring tokens, please refer to the OAuth API page

Response Parameters

Name Description Type Mandatory
addressType Address category
Classification for determining the address type in retaining the address in the address information.
KYS:Contractor Address
STB:Installation Address
String No
postalNumber Zipcode Int No
address Address
Address information in Japanese / English notation
String No
addressCode Address code
Code to identify the address
String No
banchi1 Address1
Address information1
String No
banchi2 Address2
Address information2
String No
banchi3 Address3
Address information3
String No
building1 Building1
Building information1
String No
building2 Building2
Building information2
String No
building3 Building3
Building information3
String No
samakata Samakata
Samakata information
String No
productName Product name
Name of product code
String No
productTypeName Product type name
Name of product type code
String No
itemNameProduct Item name_Contract item details
Item ID_Name of contract item details
String No
detailItemValue Detail item value
Item value in detail
String No

Example Result

{
    "addressInfo": [
    {
        "addressType": "KYS",
        "postalNumber": "1000011",
        "address": "東京都千代田●●1丁目",
        "addressCode": "12345678901",
        "banchi1": "1番6号",
        "banchi2": "",
        "banchi3": "",
        "building1": "●●●日比谷ビル",
        "building2": "",
        "building3": "",
        "samakata": ""
    },{
        "addressType": "STB",
        "postalNumber": "1000011",
        "address": "東京都千代田区●●1丁目",
        "addressCode": "12345678901",
        "banchi1": "1番6号",
        "banchi2": "",
        "banchi3": "",
        "building1": "●●●日比谷ビル",
        "building2": "1F",
        "building3": "",
        "samakata": ""
    }],
    "productInfo": [
    {
        "productName": "Universal One",
        "productTypeName": "サービス",
        "productDetailInfo": []
    },{
        "productName": "L2",
        "productTypeName": "レイヤー",
        "productDetailInfo": []
    },{
        "productName": "ギャランティ",
        "productTypeName": "プラン",
        "productDetailInfo": []
    },{
        "productName": "メイン(主回線)",
        "productTypeName": "回線利用用途",
        "productDetailInfo": [
        {
            "itemNameProduct": "冗長化グループ番号",
            "detailItemValue": ""
        },{
            "itemNameProduct": "VPN番号",
            "detailItemValue": "V12345678"
        }]
    },{
        "productName": "ギャランティアクセス",
        "productTypeName": "アクセス",
        "productDetailInfo": []
    },{
        "productName": "イーサタイプ(NTTCom光アクセス)",
        "productTypeName": "タイプ",
        "productDetailInfo": []
    },{
        "productName": "Ether",
        "productTypeName": "イーサネット種別",
        "productDetailInfo": []
    },{
        "productName": "全二重",
        "productTypeName": "通信方式",
        "productDetailInfo": []
    },{
        "productName": "10M",
        "productTypeName": "品目",
        "productDetailInfo": []
    },{
        "productName": "設置場所情報",
        "productTypeName": "部材",
        "productDetailInfo": [
        {
            "itemNameProduct": "設置場所事業所名",
            "detailItemValue": "●●●日比谷ビル"
        }]
    },{
        "productName": "L2 設置無",
        "productTypeName": "UNO-T",
        "productDetailInfo": []
    }]
}

Traffic Info

 By using this API, you can get Traffic information of Arcstar Universal One filtered by VPN group ID and service contract ID and utilization / traffic in JSON and PNG format.

To get the Traffic Information

GET /v2/uno/traffic/{vpnGroupId}/{contractId}?dataType={dataType}&from={from}&to={to}&direction={direction}&interval={interval}&format={format}       

Request Parameters

Name Description Type Mandatory
vpnGroupId VPN group ID
e.g. 'V'+8 digit number
path variable Yes
contractId Service contract ID
e.g. 'N'+9 digit number
path variable Yes
dataType Data item
utilization:Domestic line utilization rate(%)
traffic:Domestic line information amount(bps)
query argument Yes
from Display start date/time #1#2 query argument Yes
to Display end date/time #1#2 query argument Yes
direction Data transmission / reception path type
in:reception 、out:transmission、inout:reception /transmission (both)
query argument Yes
interval Plot interval
realtime(5 minutes interval),daily(24h interval) 
query argument Yes
format Return value format
json:JSON format、png:graph image in PNG format
query argument Yes

#1.Specify the time in JST.
#2.Valid only when it is real-time.

Example Request

GET /v2/uno/traffic/V12345678/N123456789?dataType=utilization&from=201801010000&to=201812312359&direction=in&interval=realtime&format=json     

Response Parameters

Name Description Type Mandatory
version Version String Yes
from Interval (From)
yyyy-MM-dd HH:mm format
String No
to Interval (To)
yyyy-MM-dd HH:mm format
String No
utilization / traffic Information on line utilization rate/ line information amount
The value changes depending on the specified data type
utilization:Output when dataType is utilization
traffic:Output when dataType is traffic
String No
prefecture Prefecture String No
companyName Company name String No
lineUseRateDayMax Maximun line utilization of the day String No
in Maximum reception amount
Output only when the direction (type) of the request parameter is in (reception), inout (reception / transmission)
String No
out Maximum transmission amount
Output only when the direction (type) of the request parameter is out (transmission), inout (reception / transmission)
String No
lineUseRate / trafficVolume Type of traffic data
The value changes depending on the specified data type
line_use_rate:Output when dataType is utilization
traffic_volume:Output when dataType is traffic
String No
in Line utilization rate(%) / Line information amount(bps)
Output only when the direction (type) of the request parameter is in (reception), inout (reception / transmission)
String No
out Line utilization (%) / Line information amount (bps)
Output only when the direction (type) of the request parameter is out (transmission), inout (reception / transmission)
String No
datetime Target date month
yyyy-MM-dd HH:mm format
String No
value Line utilization (%) / Line information amount (bps) String No
requestDateFrom Display start date/time (From)
yyyy-MM-ddTHH:mm+0900 format
String Yes
requestDateTo Display start date/time (To)
yyyy-MM-ddTHH:mm+0900 format
String Yes

Example Result

{
    "version": "1.00",
    "contractState": {
        "period": {
            "from": "2018-08-31 00:00",
            "to": ""
        }
    },
    "utilization": {
        "prefecture": "神奈川県",
        "companyName": "●●●●",
        "lineUseRateDayMax": {
            "in": "100.0",
            "out": "100.0"
        },
        "lineUseRate": {
            "in": [
            {
                "datetime": "2018-11-01 00:00",
                "value": "0.00466543888888888963"
            },{
                "datetime": "2018-11-02 00:00",
                "value": "0.00938773518518518958"
            },{
                "datetime": "2018-11-03 00:00",
                "value": "0.00471911851851852023"
            }],
            "out": [
            {
                "datetime": "2018-11-01 00:00",
                "value": "0.00544012592592593019"
            },{
                "datetime": "2018-11-02 00:00",
                "value": "0.00545079814814814975"
            },{
                "datetime": "2018-11-03 00:00",
                "value": "5.41481481481481009e-06"
            }]
        }
    },
    "requestDateFrom": "2018-11-01T12:00+0900",
    "requestDateTo": "2018-11-03T13:00+0900"
}

Circuit Alarm

  By using this API, you can get circuit alarm information of Arcstrar Universal One with in 90days by VPN group ID and service contract ID in JSON format.

To get the Circuit Alarm

GET /v2/uno/circuitalarms/{vpnGroupId}?contractId={contractId}&originalEventTimeFrom={originalEventTimeFrom}&originalEventTimeTo={originalEventTimeTo}&eventTimeFrom={eventTimeFrom}&eventTimeTo={eventTimeTo}&clearanceTimeFrom={clearanceTimeFrom}&clearanceTimeTo={clearanceTimeTo}&lastModificationTimeFrom={lastModificationTimeFrom}&lastModificationTimeTo={lastModificationTimeTo}&top={top}&skip={skip}&maxPageSize={maxPageSize}&orderBy={orderBy}  

Request Parameters

Name Description Type Mandatory
vpnGroupId VPN group ID
e.g. 'V'+8 digit number
path variable Yes
contractId Service contract ID
e.g. 'N'+9 digit number
query argument No
originalEventTimeFrom Alarm start date/time #1
e.g. 201901010000
query argument No
originalEventTimeTo Alarm end date/time #1
e.g. 201912312359
query argument No
eventTimeFrom Alarm severity update start date/time #1
e.g. 201901010000
query argument No
eventTimeTo Alarm severity update end date/time #1
e.g. 201912312359
query argument No
clearanceTimeFrom Alarm recovery start date/time #1
e.g. 201901010000
query argument No
clearanceTimeTo Alarm recovery end date/time #1
e.g. 201912312359
query argument No
lastModificationTimeFrom Last modification start date/time #1
e.g. 201901010000
query argument No
lastModificationTimeTo Last modification end date/time #1
e.g. 201912312359
query argument No
top Number of top output #2 query argument No
skip Number of skip reading #2 query argument No
maxPageSize Number of output #3 query argument No
orderBy Sort order #4
e.g. originalEventTimeFrom desc
query argument No

#1.Specify the time in JST.
#2.If not specified, it is assumed that 0 is specified.
#3.If not specified, it is assumed that 10 is specified.
#4.When specifying "alarmId" as "orderBy" or "KEY", use "id".

Example Request

GET /v2/uno/circuitalarms/V12345678?contractId=N123456789&originalEventTimeFrom=201901010000&originalEventTimeTo=201901312359&eventTimeFrom=201901010000&eventTimeTo=201901312359&clearanceTimeFrom=201901010000&clearanceTimeTo=201901312359&lastModificationTimeFrom=201901010000&lastModificationTimeTo=20190131&top=10&skip=1&maxPageSize=1&orderBy=alarmName desc,optionService     
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* For details on acquiring tokens, please refer to the OAuth API page.

Response Parameters

Name Description Type Mandatory
vpnGroupId VPN group ID String Yes
contractId Service contract ID String Yes
originalAlarmName Alarm name String Yes
originalEventTime Alarm start time(JST)
yyyy-MM-ddTHH:mm+0900 format
String Yes
alarmDescription Alarm description String No
rootCauseDescription Root cause String No
requestDescription Request for customer String No
plannedOutage Planned outage flag
true:Within planned outage period
false:Excluding planned outage period
Boolean Yes
plannedOutageDescription Planned outage flag description String Yes
noManageReason Mornitoring suspension flag
true:Within mornitoring suspension period
false:Excluding mornitoring suspension period
Boolean Yes
noManageReasonDescription Mornitoring suspension flag description String Yes
alarmId Alarm ID Int Yes
clearanceReportFlag Outage recovery flag
true:Outage recovery
false:Outage occurrence
Boolean Yes
clearanceReportFlagDescription Outage recovery flag description String Yes
alarmName Alarm name String Yes
originalSeverity Original alarm severity
5:Critical 4:Waring 3:Major 2:Minor 1:Indeterminate 0:Clear
Int Yes
originalSeverityName Original alarm severity description String Yes
perceivedSeverity Alarm severity
 5:Critical 4:Waring 3:Major 2:Minor 1:Indeterminate 0:Clear
Int Yes
perceivedSeverityName Alarm severity description String Yes
eventTime Alarm severity update time(JST)
yyyy-MM-ddTHH:mm+0900 format
String Yes
clearanceTime Outage recovery time(JST)
yyyy-MM-ddTHH:mm+0900 format
String No
lastModificationTime Last modification time(JST)
yyyy-MM-ddTHH:mm+0900 format
String Yes
* The data in the object is unsorted.
  When its response value is null, the item name will not be shown in the list.

Example Result

{
    "value": [
    {
        "contractId" : "N123456789",
        "vpnGroupId" : "V12345678",
        "originalAlarmName" : "UNO(L3) eeNMS(WAN_MAIN) Ping_status NG (/) (from:eeNMS)",
        "originalEventTime" : "2019-03-01T18:07:32+0900"
        "alarmDescription" : "There was no ping response from WAN side of UniverasalOne terminal",
        "plannedOutage" : false,
        "plannedOutageDescription" : "計画工事期間外",
        "noManageReason" : false,
        "noManageReasonDescription" : "静観期間外",
        "alarmId" : 10784000,
        "clearanceReportFlag" : false,
        "clearanceReportFlagName" : "故障発生",
        "alarmName" : "UNO(L3) eeNMS(WAN_MAIN) Ping_status NG (/) (from:eeNMS)",
        "originalSeverity" : 5,
        "originalSeverityName" : "Critical",
        "perceivedSeverity" : 5,
        "perceivedSeverityName" : "Critical",
        "eventTime" : "2019-03-02T18:07:32+0900",
        "clearanceTime" : "2019-03-0418:07:32+0900",
        "lastModificationTime" : "2019-03-04T04:00:02+0900"
    }]
}   

Planned Outage List(Guarantee Plan)

 By using this API, you can get Planned Outage List of Arcstar Universal One Guarantee Plan in JSON format.

To get the Planned Outage List

GET /v2/uno/maintenance?plan=guarantee&updateTimeFrom={updateTimeFrom}&updateTimeTo={updateTimeTo}   

Request Parameters

Name Description Type Mandatory
plan Specified constraction data plan
Fixed value:guarantee
query argument Yes
updateTimeFrom Last modified time(from)
e.g. Date : 20180101
   Date&Time : 201801010000
query argument Yes
updateTimeTo Last modified time(to)
e.g. Date : 20181231
   Date&Time : 201812312359
query argument Yes

Example Request

Content-Type: 
Host: api.ntt.com 
GET /v2/uno/maintenance?plan=guarantee&updateTimeFrom=20180803&updateTimeTo=20180827
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* Please refer to the OAuth API page for token acquisition.

Response Parameters

Name Description Type Mandatory
totalCount Tortal count of search result Int Yes
pageNumber Page number of search result Int No
pageSize Tortal count page of search result Int No
prePageNumber Previous page number Int No
nextPageNumber Next page number Int No
firstPageNumber First page number Int No
lastPageNumber Last page number Int No
lineContractId Service contract ID String No
agmUuid Borrowed line UUID String No
lastModifiedAc The last modified date
yyyy-MM-ddTHH:mm:ss.SSS+0900 format
String No

    
* If the search result pages are 2 or more, there is a possibility that all of the corresponding data could not be acquired, please narrow down the conditions and execute the API again.

Example Result

{
    "totalCount": 3,
    "pageNumber": "1",
    "pageSize": "1000",
    "prePageNumber": "1",
    "nextPageNumber": "1",
    "firstPageNumber": "1",
    "lastPageNumber": "1",
    "items": [
    {
        "lineContractId": "N123456780",
        "amgUuid": "5F123456789012345678901234567890",
        "lastModifiedAc": "2018-01-22T16:34:12.059+0900"
    },{
        "lineContractId": "N123456781",
        "amgUuid": "5F123456789012345678901234567890",
        "lastModifiedAc": "2018-01-22T16:34:12.180+0900"
    },{
        "lineContractId": "N123456782",
        "amgUuid": "5F123456789012345678901234567890",
        "lastModifiedAc": "2018-01-22T16:34:12.633+0900"
    }]
}

Planned Outage Detail Info(Guarantee Plan)

 By using this API, you can get Planned Outage Detail Information of Arcstar Universal One Guarantee Plan in JSON format.

To get the detail information of Planned Outage

GET /v2/uno/maintenance/{vpnGroupId}/{contractId}?plan=guarantee&agmUuid={agmUuid}     

Request Parameters

Name Description Type Mandatory
vpnGroupId VPN group ID
e.g. 'V'+8 digit number
path variable Yes
contractId Service contract ID
e.g. 'N'+9 digit number
path variable Yes
plan Constraction data plan
Fixed value:guarantee
query argument Yes
agmUuid Borrowed line UUID query argument No

Example Request

GET /v2/uno/maintenance/V1245678/N123456789?plan=guarantee&agmUuid=x23fd9dae90adbewefdwe482000000000000001
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* For details on acquiring tokens, please refer to the OAuth API page

Response Parameters

Name Description Type Mandatory
totalCount Tortal count of search result Int Yes
pageNumber Page number of search result Int No
pageSize Tortal count page of search result Int No
prePageNumber Previous page number Int No
nextPageNumber Next page number Int No
firstPageNumber First page number Int No
lastPageNumber Last page number Int No
lastModifiedAc Last modified date(JST)
yyyy-MM-ddTHH:mm:ss.SSS+0900 format
String No
agmUuid Line UUID String No
lineContractId Service contract ID String No
lineDescription Line type String No
serviceName Service type String No
tocWorkerDivision TOC department in charge String No
tocWorkerTel TOC responsible person's phone number String No
startDay Start date(JST)
yyyy-MM-ddTHH:mm:ss.SSS+0900 format
String No
endDay End date(JST)
yyyy-MM-ddTHH:mm:ss.SSS+0900 format
String No
impactTime Influence time Int No
timeUnit Influence time unit String No
count The number of influence Int No
* Response format and items depend on each user's contract.
  Please contact us for more information.

Example Result

{   
    "totalCount": "1",  
    "pageNumber": "1",  
    "pageSize": "10",   
    "prePageNumber": "1",   
    "nextPageNumber": "1",  
    "firstPageNumber": "1", 
    "lastPageNumber": "1",  
    "items": [  
    {   
        "lastModifiedAc": "2019-03-19T13:30:32.536+0900",   
        "agmUuid": "7A35EC89AAF56013E053E40112AC644A",  
        "lineContractId": "N123456789", 
        "lineDescription": "1", 
        "serviceName": "Universal One", 
        "tocWorkerDivision": "TOC担当部署", 
        "tocWorkerTel": "0312345678",   
        "startDay": "2018-11-20T02:00:00.000+0900", 
        "endDay": "2018-11-20T05:00:00.000+0900",   
        "impactTime": "1",  
        "timeUnit": "0",    
        "count": "1"    
    }]    
}

Planned Outage Info(Best Effort Plan)

 By using this API, you can get Planned Outage information of Arcstar Universal One Best Effort Plan filtered by VPN group ID, product code, service contract ID and area code in JSON format.

To get the detail information of Planned Outage

GET /v2/uno/maintenance?plan=besteffort&vpnGroupId={vpnGroupId}&contractid={contractid}&areacode={areacode}&goodscode={goodscode} 

Request Parameters

Name Description Type Mandatory
plan Specified construction information plan
fixed value:besteffort
query argument Yes
vpnGroupId VPN group ID
e.g. 'V'+8 digit number
query argument Yes
contractId Service contract ID
e.g. 'N'+9 digits number
query argument No
areaCode Specified area code
Area code: 3 digit number
query argument No
goodsCode Specified product code
Fixed value: vpn-besteffort
query argument Yes

Area Code

Location code Prefecture code
301: Hokkaido 401: Hokkaido
302: Tohoku 402: Aomori, 403: Iwate, 404: Miyagi, 405: Akita, 406: Yamagata, 407: Fukushima
303: Kanto 408: Tokyo, 409: Kanagawa, 410: Saitama, 411: Chiba, 412 Ibaraki, 413: Tochigi, 414: Gunma
304: Tokai 421: Aichi, 422: Gifu, 423: Shizuoka, 424: Mie
305: Koushinetsu 415: Yamanashi, 416: Niigata, 417: Nagano
306: Hokuriku 418: Toyama, 419: Ishikawa, 420: Fukui
307: Kinki 425: Osaka, 426: Hyogo, 427: Kyoto, 428: Shiga, 429: Nara, 430: Wakayama
308: Chugoku 431: Tottori, 432: Shimane, 433: Okayama, 434: Hiroshima, 435: Yamaguchi
309: Shikoku 436: Tokushima, 437: Kagawa, 438: Ehime, 439: Kochi
310: Kyushu 440: Fukuoka, 441: Saga, 442: Nagasaki, 443: Kumamoto, 444: Oita, 445: Miyazaki, 446: Kagoshima, 447: Okinawa

Example Request

GET /v2/uno/maintenance?plan=besteffort&vpnGroupId=V12345678&contractId=N123456789&areaCode=408&goodsCode=vpn-besteffort     
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* Please refer to the OAuth API page for token acquisition.

Response Parameters

Name Description Type Mandatory
title Construction / Outage title String No
kind Construction / Outage type
1: Construction 2: Outage
Int No
kindDescription Construction / Outage type name String No
code Construction / Outage ID String No
displayUpdateDate Updated date for display(JST)
yyyy-MM-ddTHH:mm+0900 format(JST)
String No
displayUpdateDateUtc Updated date for display(UTC)
yyyy-MM-ddTHH:mmZ format(UTC)
String No
maintenanceStatus Maintenance status
1: Before Construction 2: Under Construction 3: Done
Int No
maintenanceStatusDescription Maintenance status name String No
troubleStatus Outage status 1: Failed 2: Restored Int No
troubleStatusDescription Outage status name String No
importantFlg Important flag
0: Normal (0 for faults fixed) 1: Important
Int No
importantDescription Important Description String No
maintenanceStartDate Maintenance start date
yyyy-MM-ddTHH:mm+0900 format(JST)
String No
maintenanceEndDate Maintenance end date
yyyy-MM-ddTHH:mm+0900 format(JST)
String No
troubleOccuredDate Outage occured date
yyyy-MM-ddTHH:mm+0900 format(JST)
String No
troubleRestoreDate Outage restore date
yyyy-MM-ddTHH:mm+0900 format(JST)
String No
maintenanceStartDateUtc Maintenance Start Date(UTC)
yyyy-MM-ddTHH:mmZ format(UTC)
String No
maintenanceEndDateUtc Maintenance End Date(UTC)
yyyy-MM-ddTHH:mmZ format(UTC)
String No
troubleOccuredDateUtc Trouble occured date(UTC)
yyyy-MM-ddTHH:mmZ format(UTC)
String No
troubleRestoreDateUtc Trouble restore date(UTC)
yyyy-MM-ddTHH:mmZ format(UTC)
String No
targetArea Affected area code String No
mainTextPc Text for PC site String No
influencedPlanDisplay Affected service (for screen display)
Affected services that are displayed on the screen when construction / outage registered
String No
targetFacilityDisplay Affected facility (for screen display)
Affected facilities that are displayed on the screen when construction / outage registered
String No
targetAreaDisplay Affected area (for screen display)
Affected areas that are displayed on the screen when construction / outage registered
String No

Example Result

{
    "items": [
    {
        "title": "【L3 ベストエフォート】青森県エリア地域IP網メンテナンス工事のお知らせ",
        "kind": 1,
        "kindDescription": "工事",
        "code": "12001",
        "displayUpdateDate":"2018-10-19T15:04+0900",
        "displayUpdateDateUtc":"2018-10-19T06:04Z",
        "maintenanceStatus": 3,
        "maintenanceStatusDescription": "完了",
        "troubleStatus": "",
        "troubleStatusDescription": "",
        "importantFlg": 0,
        "importantDescription": "通常",
        "maintenanceStartDate": "2018-10-26T00:00+0900",
        "maintenanceEndDate": "2018-10-26T06:00+0900",
        "troubleOccuredDate": "",
        "troubleRestoreDate": "",
        "maintenanceStartDateUtc": "2018-10-25T15:00Z",
        "maintenanceEndDateUtc": "2018-10-25T21:00Z",
        "troubleOccuredDateUtc": "",
        "troubleRestoreDateUtc": "",
        "targetArea": "402",
        "mainTextPc": "特定加入者回線部分のアクセスポイントで、工事時間帯において一時的にご利用できなくなる場合がございます。",
        "influencedPlanDisplay": "特定加入者回線部分(光ネクスト)",
        "targetFacilityDisplay": "",
        "targetAreaDisplay": "青森県エリアの全域"
    }]
}

Monitoring Suspension Info

  By using this API, you can get monitoring suspension information by VPN group ID, service contract ID, cutomer system ID, work start date and work end date in JSON format.

To get monitoring suspension information

GET /v2/uno/monitoringsuspension/{customerSysId}/{vpnGroupId}/{contractId}?workDateFrom={workDateFrom}&workDateTo={workDateTo} 

Request Parameters

Name Description Type Mandatory
customerSysId Cutomer system ID
e.g. 'A'+9 digits number
path variable Yes
vpnGroupId VPN group ID
e.g. 'V'+8 digit number
path variable Yes
contractId Service contract ID
e.g. 'N'+9 digits number
path variable Yes
workDateFrom Work start date/time #1 #2 #3
e.g. 201901010000
query argument No
workDateTo Work end date/time #1 #3 #4
e.g. 201912312359
query argument No

#1.Specify the time in JST.
#2.If not specified, it is assumed that the current time is specified.
#3.When you set second, it is allowed to set '00' or '59' only.
#4.If not specified, it is assumed that one year after the current time is specified.

Example Request

GET /v2/uno/monitoringsuspension/A123456789/V12345678/N123456789?workDateFrom=20190101130000&workDateTo=20191231235959     
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* For details on acquiring tokens, please refer to the OAuth API page.

Response Parameters

Name Description Type Mandatory
insertDate Created date(JST)
yyyy-MM-ddTHH:mm+0900 format
String No
workId Work ID Int No
workDiv Work division
01:SO Maint(order maintenance) 02:Com Maint(NTTCommunication's maintenance) 03:Cust Maint(customer's maintenance) 04:Testing(circuit test) 05:Urgent Maint(urgent maintenance) 99:Others
Int No
workDivDescription Work division description String No
workTargetId Work target ID String No
workTargetDiv Work target divison
01:Customer System 02:Network 03:Site 04:Circuit 05:CPE/LAN Equipment
Int No
workTargetDivDescription Work target division description String No
workRepeatDiv Work repeat division
00:No 10:Every day 20:Weekly 30:Monthly 40:Holiday 90:Permanent
Int No
workRepeatDivDescription Work repeat division description String No
workDateFrom Work start date
yyyy-MM-ddTHH:mm+0900 format
String No
workDateTo Work end date
yyyy-MM-ddTHH:mm+0900 format
String No
workTimeFrom Work start time(JST)
HH24:MM:SS format
String No
workTimeTo Work end time(JST)
HH24:MM:SS format
String No
workWeekdayFrom Work start weekday code
01:Sun 02:Mon 03:Tue 04:Wed 05:Thu 06:Fri 07:Sat
Int No
workWeekdayFromName Work start weekday code description String No
workWeekdayTo Work end weekday code
01:Sun 02:Mon 03:Tue 04:Wed 05:Thu 06:Fri 07:Sat
Int No
workWeekdayToName Work end weekday code description String No
workDayFrom Work start day code
01~31:1st~31th 98:The day before the end of the month 99:the end of the month
Int No
workDayFromName Work start day code description String No
workDayTo Work end day code
01~31:1st~31th 98:The day before the end of the month 99:the end of the month
Int No
workDayToName Work end day code description String No
workHolidayFrom Work start holiday code
01:Yesterday Before Holiday 02:Before Holiday 03:Holiday 04:After Holiday 05:Tommorow After Holiday
Int No
workHolidayFromName Work start holiday code description String No
workHolidayTo Work end holiday code
01:Yesterday Before Holiday 02:Before Holiday 03:Holiday 04:After Holiday 05:Tommorow After Holiday
Int No
workHolidayToName Work end holiday code description String No
remarks Remarks String No
receiptNo Receipt number Int No
parentWorkId Parent work ID Int No
workEndIssue Work end issue
0:Don't issue a ticket 1:Issue a ticket
Int No
workEndIssueDescription Work end issue description String No

Example Result

{
    "items":[
    {
        "insertDate":"2019-01-01T00:00:00+0900",
        "workId":"0001234567",
        "workDiv":"04",
        "workDivDescription":"Testing(回線試験)",
        "workTargetId":"N123456789",
        "workTargetDiv":"04",
        "workTargetDivDescription":"Circuit(回線)",
        "workRepeatDiv":"20",
        "workRepeatDivDescription":"Weekly(毎週)",
        "workDateFrom":"2019-01-01T09:00:00+0900",
        "workDateTo":"2019-12-31T23:59:59+0900",
        "workTimeFrom":"110000",
        "workTimeTo":"200000",
        "workWeekdayFrom":"06",
        "workWeekdayFromName":"Fri(金)",
        "workWeekdayTo":"01",
        "workWeekdayToName":"SUN(日)",
        "workDayFrom":"",
        "workDayFromName":"",
        "workDayTo":"",
        "workDayToName":"",
        "workHolidayFrom":"",
        "workHolidayFromName":"",
        "workHolidayTo":"",
        "workHolidayToName":"",
        "remarks":"",
        "receiptNo":"",
        "parentWorkId":"",
        "workEndIssue":"0",
        "workEndIssueDescription":"アラートチケットを起票しない"
    }]  
}   

Monitoring Suspension Register

  By using this API, you can register monitoring suspension information by VPN group ID, service contract ID and cutomer system ID.

To register monitoring suspension infotmation

POST /v2/uno/monitoringsuspension/{customerSysId}/{vpnGroupId}/{contractId}  

Request Parameters

Name Description Type Mandatory
customerSysId Cutomer system ID
e.g. 'A'+9 digits number
path variable Yes
vpnGroupId VPN group ID
e.g. 'V'+8 digit number
path variable Yes
contractId Service contract ID
e.g. 'N'+9 digits number
path variable Yes
workDiv Work division
01:SO Maint(order maintenance) 02:Com Maint(NTTCommunication's maintenance) 03:Cust Maint(customer's maintenance) 04:Testing(circuit test) 05:Urgent Maint(urgent maintenance) 99:Others
JSON Yes
workTargetDiv Work target division
04:Circuit 05:CPE/LAN Equipments
JSON Yes
workRepeatDiv Work repeat division
00:No 10:Every day 20:Weekly 30:Monthly 40:Holiday 90:Permanent
JSON Yes
workDateFrom Work start date #1#2
e.g. 2019-04-01T10:00:00+0900
JSON No
workDateTo Work end date #1#2
e.g. 2019-04-30T23:59:59+0900
JSON No
workTimeFrom Work start time #1#2
e.g. 10:00:00
JSON No
workTimeTo Work end time ##1#2
e.g. 23:59:59
JSON No
workWeekdayFrom Work start weekday #1
01:Sun 02:Mon 03:Tue 04:Wed 05:Thu 06:Fri 07:Sat
JSON No
workWeekdayTo Work end weekday #1
01:Sun 02:Mon 03:Tue 04:Wed 05:Thu 06:Fri 07:Sat
JSON No
workDayFrom Work start day #1
01~31:1st~31th 99:the end of the month
JSON No
workDayTo Work end day #1
01~31:1st~31th 99:the end of the month
JSON No
workHolidayFrom Work start holiday code
02:Before Holiday 03:Holiday 04:After Holiday 05:Tommorow After Holiday
JSON No
workHolidayTo Work end holiday code
02:Before Holiday 03:Holiday 04:After Holiday 05:Tommorow After Holiday
JSON No
remarks Remarks
e.g. 「計画停電を予定」
JSON No
workEndIssue Work end issue
0:Don't issue a ticket 1:Issue a ticket
JSON Yes

#1.Specify the time in JST.
#2.When you set second, it is allowed to set '00' or '59' only.

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com
POST /v2/uno/monitoringsuspension/A123456789/V12345678/N123456789     
{
  "workDiv":"01",
  "workTargetDiv":"04",
  "workRepeatDiv":"10",
  "workDateFrom":"2019-04-01T10:00:00+0900",
  "workDateTo":"2019-12-31T23:59:59+0900",
  "workTimeFrom":"10:00:00",
  "workTimeTo":"23:59:59",
  "workWeekdayFrom":"02",
  "workWeekdayTo":"02",
  "workDayFrom":"01",
  "workDayTo":"31",
  "remarks":"計画停電を予定",
  "workEndIssue":1
}
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* For details on acquiring tokens, please refer to the OAuth API page.

Response Parameters

None ※Only HTTP header will be returned.

Monitoring Suspension Update

  By using this API, you can update information of monitoring suspension by VPN group ID, service contract ID and cutomer system ID.

To update monitoring suspension information

PUT /v2/uno/monitoringsuspension/{customerSysId}/{vpnGroupId}/{contractId}  

Request Parameters

Name Description Type Mandatory
customerSysId cutomer system ID
e.g. 'A'+9 digits number
path variable Yes
vpnGroupId VPN group ID
e.g. 'V'+8 digit number
path variable Yes
contractId Service contract ID
e.g. 'N'+9 digits number
path variable Yes
insertDate Created date(JST) #1
e.g. 2019-01-01T00:00:00+0900
JSON Yes
workId Work ID
e.g. 0001234567
JSON Yes
workDateFrom Work start date #1#2
e.g. 2019-04-01T10:00:00+0900
JSON No
workDateTo Work end date #1#2
e.g. 2019-04-30T23:59:59+0900
JSON No
remarks Remarks
e.g. 「計画停電を予定」
JSON No
workEndIssue Work end issue
0:Don't issue a ticket 1:Issue a ticket
JSON Yes

#1.Specify the time in JST.
#2.When you set second, it is allowed to set '00' or '59' only.

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com
PUT /v2/uno/monitoringsuspension/A123456789/V12345678/N123456789     
{
  "insertDate":"2019-01-01T00:00:00+0900",
  "workId":"0001234567",
  "workDateFrom":"2019-04-01T10:00:00+0900",
  "workDateTo":"2019-12-31T23:00:00+0900",
  "remarks":"計画停電を予定",
  "workEndIssue":"1"
}
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* For details on acquiring tokens, please refer to the OAuth API page.

Response Parameters

None ※Only HTTP header will be returned.

Monitoring Suspension Delete

  By using this API, you can delete information of monitoring suspension by VPN group ID, service contract ID and cutomer system ID.

To delete monitoring suspension information

DELETE /v2/uno/monitoringsuspension/{customerSysId}/{vpnGroupId}/{contractId}  

Request Parameters

Name Description Type Mandatory
customerSysId Cutomer system ID
e.g. 'A'+9 digits number
path variable Yes
vpnGroupId VPN group ID
e.g. 'V'+8 digit number
path variable Yes
contractId Service contract ID
e.g. 'N'+9 digits number
path variable Yes
insertDate Created date(JST) #1
e.g. 2019-01-01T00:00:00+0900
JSON Yes
workId Work ID
e.g. 0001234567
JSON Yes

#1.Specify the time in JST.

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com
DELETE /v2/uno/monitoringsuspension/A123456789/V12345678/N123456789     
{
  "insertDate":"2019-01-01T00:00:00+0900",
  "workId":"0001234567"
}
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* For details on acquiring tokens, please refer to the OAuth API page.

Response Parameters

None ※Only HTTP header will be returned.


  1. Dec. 2014 currently, DNS round robin operation. Apr. 2015 or later, API request will automatically connect to geographically close API gateway