WideAngle API

Overview

 This APIs allow you to get/update contract master information, get ticket information of WideAngle MSS, and get ABTI blacklist. WideAngle MSS provides the following APIs.

Contract Master API

API Description
getServiceMasterData To retrieve service master data.
getVulnerabilityDiagnosisServiceMasterData To retrieve Vulnerability diagnosis service master data.
getDeviceMasterData To retrieve device master data.
getDeviceConstructionMasterData To retrieve device construction master data.
getDeviceLicenseMasterData To retrieve device license master data.
getDeviceMaintenanceMasterData To retrieve device maintenance master data.
getOptionServiceMasterData To retrieve option service master data.
getContractProjectsList To retrieve contracts list.
getTheContractProjectDetail To retrieve the contract detail.
getTheCHBBasicInfoList To retrieve a list of CHB basic information.
getTheCHBBasicInfoDetail To retrieve the detail of the CHB basic information.
updateCHBBasicInfo To update CHB basic information.

Ticket Reference API

API Description
Ticket List Reference Get ANALYSIS Portal’s ticket list.
Ticket Detail Reference Get ANALYSIS Portal’s ticket detail.
Ticket Attached File Reference Get ANALYSIS Portal’s ticket attached files.

ABTI BlackList API

API Description
getABTIBlackList Get ABTI Blacklist.

Resource URL

 "Globally Common Domain (Global Load Balance)" or "Individual Region Domain (Region)" should be utilized. When using the globally common domain, a connection will be made to the nearest API Gateway according to the Customer's usage details.

1.Base Path(Global Load Balance)
Contract Master API : https://api.ntt.com/v1/mss/contract/master/
Ticket Reference API: https://api.ntt.com/v1/mss/analysisportal/
ABTI BlackList API: https://api.ntt.com/v1/abti/

2.Base Path(Region)
Contract Master API : https://{region}.api.ntt.com/v1/mss/contract/master/
Ticket Reference API: https://{region}.api.ntt.com/v1/mss/analysisportal/
ABTI BlackList API: https://{region}.api.ntt.com/v1/abti/
‧ region : jp|us|uk
‧ e.g. https://us.api.ntt.com/v1/mss/contract/master/

Contract Master API

getServiceMasterData

GET /v1/mss/contract/master/service?secretKey={secret-key}

To retrieve service master data.

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes
offset starting position query argument No 0 ※from the head of the data
limit maximum value query argument No 300

Example Request

GET /v1/mss/contract/master/service?secretKey={secret-key}&offset={starting-position}&limit={maximum-value}

Response Parameters

Name Description type
result number of retrieving elements number
offset starting position to retrieve number
total total number of elements number
name service name string
initialCost initial charge offered for customer number
monthlyCost monthly charge offered for customer number
operationLevel operation level string
serviceMenu1 service menu 1 string
serviceMenu2 service menu 2 string
serviceSize service size string

Example Result

{           
    "result" : 100,     
    "offset"  : 0,      
    "total" : 100,      
    "entries" : [       
        {   
            "name" : "NWセキュリティ基本パック/アクア/L",
            "initialCost" : 1000000,
            "monthlyCost" : 200000,
            "operationLevel" : "アクア",
            "serviceMenu1" : "NWセキュリティ基本パック",
            "serviceMenu2" : null,
            "serviceSize" : "L",
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}           

getVulnerabilityDiagnosisServiceMasterData

GET /v1/mss/contract/master/assessment-service?secretKey={secret-key}

To retrieve Vulnerability diagnosis service master data.

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes
offset starting position query argument No 0 ※from the head of the data
limit maximum value query argument No 300

Example Request

GET /v1/mss/contract/master/assessment-service?secretKey={secret-key}&offset={starting-position}&limit={maximum-value}

Response Parameters

Name Description type
result number of retrieving elements number
offset starting position to retrieve number
total total number of elements number
ip number of IP addresses number
standardPrice charge for standard menu number
inspectionPrice chrage for inspection of false detection number
scanPrice charge for credential scan number
reportPrice charge for report number
attachmentPrice charge for attached list of detection result number
mediaPrice charge for media delivery number
printPrice charge for print delivery number
conferencePrice charge for debriefing session number

Example Result

{           
    "result" : 100,     
    "offset"  : 0,      
    "total" : 100,      
    "entries" : [       
        {   
            "ip" : 1,
            "standardPrice" : 10000,
            "inspectionPrice" : 10000,
            "scanPrice" : 10000,
            "reportProce" : 10000,
            "attachmentPrice" : 10000,
            "mediaPrice" : 10000,
            "printPrice" : 10000,
            "conferencePrice" : 10000
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

getDeviceMasterData

GET /v1/mss/contract/master/device?secretKey={secret-key}

To retrieve device master data.

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes
offset starting position query argument No 0 ※from the head of the data
limit maximum value query argument No 300

Example Request

GET /v1/mss/contract/master/device?secretKey={secret-key}&offset={starting-position}&limit={maximum-value}

Response Parameters

Name Description type
result number of retrieving elements number
offset starting position to retrieve number
total total number of elements number
deviceName device product name string
deviceType device type string
deviceModel device models string
purchasePrice purchase device charge offered for customer number
rentalPrice rental device charge offered for customer number

Example Result

{           
    "result" : 100,     
    "offset"  : 0,      
    "total" : 100,      
    "entries" : [       
        {   
            "deviceName" : "Palo Alto PA-3050",
            "deviceType" : "Palo Alto",
            "deviceModel" : "PA-3050",
            "purchasePrice" : 100000,
            "rentalPrice" : 10000
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

getDeviceConstructionMasterData

GET /v1/mss/contract/master/device-construction?secretKey={secret-key}

To retrieve device construction master data.

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes
offset starting position query argument No 0 ※from the head of the data
limit maximum value query argument No 300

Example Request

GET /v1/mss/contract/master/device-construction?secretKey={secret-key}&offset={starting-position}&limit={maximum-value}

Response Parameters

Name Description type
result number of retrieving elements number
offset starting position to retrieve number
total total number of elements number
deviceConstructionName name of the device installation work string
deviceType device type string
constructionPrice installation charge offered for customer number

Example Result

{           
    "result" : 100,     
    "offset"  : 0,      
    "total" : 100,      
    "entries" : [       
        {   
            "deviceConstructionName" : "機器設計・設定・リモート試験(シングル)/Palo Alto",
            "deviceType" : "Palo Alto",
            "constructionPrice" : 10000
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

getDeviceLicenseMasterData

GET /v1/mss/contract/master/license?secretKey={secret-key}

To retrieve device license master data.

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes
offset starting position query argument No 0 ※from the head of the data
limit maximum value query argument No 300

Example Request

GET /v1/mss/contract/master/license?secretKey={secret-key}&offset={starting-position}&limit={maximum-value}

Response Parameters

Name Description type
result number of retrieving elements number
offset starting position to retrieve number
total total number of elements number
licenseName name of the device license string
deviceType device type string
deviceModel device models string
licensePrice device license charge offered for customer number

Example Result

{           
    "result" : 100,     
    "offset"  : 0,      
    "total" : 100,      
    "entries" : [       
        {   
            "licenseName" : "Threat prevention subscription for device in an HA PA-3500 1年間",
            "deviceType" : "Palo Alto",
            "deviceModel" : "PA-3050",
            "licensePrice" : 100000
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

getDeviceMaintenanceMasterData

GET /v1/mss/contract/master/maintenance?secretKey={secret-key}

To retrieve device maintenance master data.

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes
offset starting position query argument No 0 ※from the head of the data
limit maximum value query argument No 300

Example Request

GET /v1/mss/contract/master/maintenance?secretKey={secret-key}&offset={starting-position}&limit={maximum-value}

Response Parameters

Name Description type
result number of retrieving elements number
offset starting position to retrieve number
total total number of elements number
maintenanceName maintenance service name for the device string
deviceType device type string
deviceModel device models string
maintenancePrice device maintenance charge offered for customer number

Example Result

{           
    "result" : 100,     
    "offset"  : 0,      
    "total" : 100,      
    "entries" : [       
        {   
            "maintenanceName" : "Threat prevention subscription for device in an HA PA-3500 1年間",
            "deviceType" : "Palo Alto",
            "deviceModel" : "PA-3050",
            "maintenancePrice" : 100000
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

getOptionServiceMasterData

GET /v1/mss/contract/master/option?secretKey={secret-key}

To retrieve option service master data.

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes
offset starting position query argument No 0 ※from the head of the data
limit maximum value query argument No 300

Example Request

GET /v1/mss/contract/master/option?secretKey={secret-key}&offset={starting-position}&limit={maximum-value}

Response Parameters

Name Description type
result number of retrieving elements number
offset starting position to retrieve number
total total number of elements number
optionName option service name string
deviceType device type string
optionInitialPrice option service initial charge offered for customer number
optionMonthlyPrice option service monthly charge offered for customer number

Example Result

{           
    "result" : 100,     
    "offset"  : 0,      
    "total" : 100,      
    "entries" : [       
        {   
            "optionName" : "Palo Alto オプションサービス",
            "deviceType" : "Palo Alto",
            "optionInitialPrice" : 100000,
            "optionMonthlyPrice" : 100000
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}  

getContractProjectsList

GET /v1/mss/contract/contract-project?secretKey={secret-key}

To retrieve contracts list.

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes
offset starting position query argument No 0 ※from the head of the data
limit maximum value query argument No 300

Example Request

GET /v1/mss/contract/contract-project?secretKey={secret-key}&offset={starting-position}&limit={maximum-value}

Response Parameters

Name Description type
result number of retrieving elements number
offset starting position to retrieve number
total total number of elements number
contractProjectID contract ID string
contractProjectName contract name string

Example Result

{           
    "result" : 100,     
    "offset"  : 0,      
    "total" : 100,      
    "entries" : [       
        {   
            "contractProjectID" : "xxxxxxxxxxxxxxxxx",
            "contractProjectName" : "ABC通信会社案件"
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

getTheContractProjectDetail

GET /v1/mss/contract/contract-project/{contract-project-ID}?secretKey={secret-key}

To retrieve the contract detail.

Request Parameters

URL Path Parameter

Description | Type | Mandatory
contract-project-ID | string | Yes

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes

Example Request

GET /v1/mss/contract/contract-project/{contract-project-ID}?secretKey={secret-key}

Response Parameters

Name Description type
contractProjectID contract ID string
contractProjectName contract name string
contractorName the conractor name string
contractPeriod term of contract(number of months) number
orderDate order date string (yyyymmdd)
commonCustomerID common customer ID(C Number) string
offerStartDate service start date string (yyyymmdd)
offerEndDate expected service end date string (yyyymmdd)
projectManagementNum project management number(contract ID) string
resaleClientName end-user name string
notices special notes for the contract string
detailsNum the number of contract details number
contractDetailsID contract detail ID string
recordType record types string
baseAdress address of installation site string
baseCountry country of installation site string
baseIdentifier identifier of installation site string
clientVM number of clients・number of virtual machines number
connLineType management connection, type of lines string
deviceDeliveryDate device delivery date string (yyyymmdd)
deviceOfferType type of providing device string
deviceOffer with or without providing device string
deviceType device type string
HA HA structure string
otherModel model name when deviceModel is "other" string
otherServiceName service name when service is "other" string
serviceNotices special contract item of service string
serviceEndDate end date of providing service string (yyyymmdd)
servicePeriod term of providing service(number of months) number
serviceStartDate start date of providing service string (yyyymmdd)
service service name string
construction name of the device intallation work string
otherName name of the device installation work when construction is "other" string
device device product name string
deviceHost device host name string
deviceIp IP address of the device string
deviceNum number of devices number
offerPeriod term of providing device number
deviceInstallationDate date of device installation string (yyyymmdd)
license name of the device license string
StartDate start date of license string (yyyymmdd)
EndDate end date of license string (yyyymmdd)
maintenance name of the device maintenance string
maintenanceType types of device maintenance string
option option service name string
module name of the device module string
moduleModel model number of device module string
moduleNum number of device modules number
remoteIp number of IP addresses of remote diagnosis number
onsiteIp number of IP addresses of on-site diagnosis number
asopInspection inspection of false detection number(0:FALSE, 1:TRUE)
asopScan credential scan number(0:FALSE, 1:TRUE)
asopReport report number(0:FALSE, 1:TRUE)
asopAttachment attached list of detection result number(0:FALSE, 1:TRUE)
asopMedia media delivery number(0:FALSE, 1:TRUE)
asopPrint print delivery number(0:FALSE, 1:TRUE)
asopConference debriefing session number(0:FALSE, 1:TRUE)
asopOtherName name of other pricing item string
asopStartDate1 prefered start date of diagnosis 1 string (yyyymmdd)
asopEndDate1 prefered end date of diagnosis 1 string (yyyymmdd)
asopStartDate2 prefered start date of diagnosis 2 string (yyyymmdd)
asopEndDate2 prefered end date of diagnosis 2 string (yyyymmdd)
asopRequest customer request etc. string

Example Result

{           
    "contractProjectID" : "xxxxxxxxxx",     
    "contractProjectName" : "ABC通信会社案件",        
    "contractorName" : "鈴木 一郎",     
    "contractPeriod" : 36,      
    "orderDate"  : "20161201",      
    "commonCustomerID" : "xxxxxxxxxxxxxxxxx",       
    "offerStartDate"  : "20170101",     
    "offerEndDate"  : "20191231",       
    "projectManagementNum" : "zzzzzzzzzzzzzzz",     
    "resaleClientName"  : "ABC株式会社",        
    "resaleClientName"  : "ABC株式会社",        
    "notices" : "特になし",     
    "detailsNum" : 3,       
    "details" : [       
        {   
            "contractDetailsID" : "xxxxxxxxxxxx",
            "recordType" : "service",
            "baseAdress" : "東京都港区XXXXXXX",
            "baseCountry" : "日本",
            "baseIdentifier" : "JP",
            "clientVM" : 1,
            "connLineType" : "インターネット接続",
            "deviceDeliveryDate" : "20160101"
            "deviceOfferType" : "お買上げ"
            "deviceOffer" : "有",
            ・・・ 中略 ・・・
            "service" : "コンテンツセキュリティ基本パック/スカイ/L"
        },  
        {   
            "contractDetailsID" : "xxxxxxxxxxxx",
            "recordType" : "device",
            "deviceHost" : "Palo1",
            "deviceIp" : "150.x.x.x",
            "deviceNum" : 2,
            ・・・ 中略 ・・・
            "device" : "Palo Alto Networks PA-3050"
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

getTheCHBBasicInfoList

GET /v1/mss/contract/chb?secretKey={secret-key}

To retrieve a list of CHB basic informations.

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes
offset starting position query argument No 0 ※from the head of the data
limit maximum value query argument No 300

Example Request

GET /v1/mss/contract/chb?secretKey={secret-key}&offset={starting-position}&limit={maximum-value}

Response Parameters

Name Description type
result number of retrieving elements number
offset starting position to retrieve number
total total number of elements number
entries retrieving elements array
projectManagementNum project management number(contract ID) string
projectName project name string

Example Result

{           
    "result" : 230,     
    "offset"  : 0,      
    "total" : 230,      
    "entries" : [       
        {   
            "projectManagementNum" : "xxxxxxxxxxxxxxxxx",
            "projectName" : "ABC通信会社案件"
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}           

getTheCHBBasicInfoDetail

GET /v1/mss/contract/chb/{project-management-number(contract ID)}?secretKey={secret-key}

To retrieve the detail of the CHB basic information.

Request Parameters

URL Path Parameter

Description | Type | Mandatory
project-management-number(contract ID) | string | Yes

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes

Example Request

GET /v1/mss/contract/chb/{project-management-number(contract ID)}?secretKey={secret-key}

Response Parameters

Name Description type
version version of the message string
projectManagementNum project management number(contract ID) string
projectName project name string
offerForm type of providing service string
passPhrase path phrase to contact SOC string
contractNumber contract number string
contactPerson contact person array
contactPersonNo contact person number number (1~6)
enableFlag set 1 to activate the contact person number (0~1)
conpanyName company name string
groupName name of the person or the department in charge string
groupNameKana Kana indicating the pronunciation of the name of the person or the department name in charge string
socNoticeTel1 telephone number to receive contact from SOC ①(priority) string
socNoticeTel2 telephone number to receive contact from SOC ② string
senderMailAddress "FROM" email address to authorize as an authentic sender string
weekdayContactOrder order to call during daytime on weekdays number (1~6)
exceptWdayConOrder order to call except during daytime on weekdays number (1~6)
workTime period of daytime array
workTimeStart starting time string
workTimeEnd ending time string
noticeMail email address to be sent notification array
socNoticeMail email address to be sent notification from SOC string
csPortalTicketMail email address to be sent notification of customer portal ticket string
csPortalAccount account information to access Customer Portal array
guideMail mail address to receive a guide for connection authentification to Customer Portal string
connUrl URL to access Customer Portal string
reportSchedule schedule for monthly report string
customerName customer name or company name string
customerNameEN customer name or company name in English string
commonCustomerID common customer ID(C Number) string
resaleClientName end-user name string
countryName country(A-END) string
timeZone time zone string
remarks notes string

Example Result

{           
    "version" : "MSSAPI1.0",        
    "projectManagementNum" :"111000000001424",      
    "projectName" : "外部1014",       
    "offerForm" : "ECL1.0セキュリティオプション",      
    "passPhrase" : "12345abcdef",       
    "contractNumber" : "CPxxxxx1",      
    "contactPerson"  : [        
        {   
            "contactPersonNo" : 1,
            "enableFlag" : 1,
            "conpanyName" : "ABC株式会社",
            "groupName" : "経営企画部門",
            "groupNameKana" : "けいえいきかくぶもん",
            "socNoticeTel1" : "080 XXXX XXXX",
            "socNoticeTel2" : "080 XXXX XXXX",
            "senderMailAddress" : "abc@abc.co.jp",
            "weekdayContactOrder" : 1,
            "exceptWdayConOrder" : 1
        },  
        ・・・ 取得項目数分 ・・・
    ],      

    "workTime"  : [
        {   
            "workTimeStart" : "9:00",
            "workTimeEnd" : "18:00"
        },  
    ],      

    "noticeMail" : [
        {
            "socNoticeMail" : "abc@abc.co.jp",
            "csPortalTicketMail" : "abc@abc.co.jp"
        }
    ],
    "csPortalAccount"  : [
        {
            "guideMail" : "abc@abc.co.jp",
            "connUrl ": "https://pc2.mob-connect.com/mccore/start/start.do?C-xxxxx&U=xxxxxxxxxxxx&S=xxx"
        }
        ・・・ 取得項目数分 ・・・
    ],
    "reportSchedule" : "毎月15日締め、当月末営業日までに提出(初回提出レポートは初月締日前データを含め翌月末提出)",
    "customerName" : "CP株式会社",
    "customerNameEN" : "CPxxxxx1",
    "commonCustomerID" : "xxxxxxxxxx",
    "resaleClientName" : "ABC",
    "countryName" : "日本",
    "timeZone" : "JST",
    "remarks" : "ABC"
}    

updateCHBBasicInfo

POST /v1/mss/contract/chb/{project-management-number(contract ID)}?secretKey={secret-key}

To update CHB basic information.

Request Parameters

URL Path Parameter

Description | Type | Mandatory
project-management-number(contract ID) | string | Yes

URL Query Parameter

Name Description Type Mandatory Default
secretKey secret key query argument Yes

Body

Name Description Type Mandatory
version version of the message string
contactPerson contact person array
contactPersonNo contact person number number (1~6)
conpanyName company name string
groupName name of the person or the department in charge string
groupNameKana Kana indiacating the pronunciation for the name of the person or the department in charge string
socNoticeTel1 telephone number to receive contact from SOC ①(priority) string
socNoticeTel2 telephone number to receive contact from SOC ② string
senderMailAddress "FROM" email address to authorize as an authentic sender string
weekdayContactOrder order to call during daytime on weekdays string
exceptWdayConOrder order to call except during daytime on weekdays string
workTime period of daytime array
workTimeStart starting time string
workTimeEnd ending time string

Notice: Please set "Content-Type : application/json" in the JSON request header.

Example Request

POST /v1/mss/contract/chb/{project-management-number(contract ID)}?secretKey={secret-key}
{
    "version" : "MSSAPI1.0",

    "contactPerson"  : [
        {
            "contactPersonNo" : 1,
            "conpanyName" : "ABC株式会社",
            "groupName" : "経営企画部門",
            "groupNameKana" : "けいえいきかくぶもん",
            "socNoticeTel1" : "080 XXXX XXXX",
            "socNoticeTel2" : "080 XXXX XXXX",
            "senderMailAddress" : "abc@abc.co.jp",
            "weekdayContactOrder" : 1,
            "exceptWdayConOrder" : 1
        }
        ・・・ 更新項目数分 ・・・
    ],
    "workTime"  : [
        {
            "workTimeStart" : "9:00",
            "workTimeEnd" : "18:00"
        }
    ]
}

Response Parameters

Name Description type
version version of the message string
result result of the execution string
errMessage error message during execution string

Example Response

{
    "version" : "MSSAPI1.0",
    "result" : "OK",
    "errMessage" : null,
}

Ticket Reference API

Ticket List Reference

GET /v1/mss/analysisportal/ticket-list

This API allows you to get ANALYSIS Portal’s ticket list.

URL Query Parameter

Name Description Mandatory  -
TargetDateEQ Target Date Yes #1
StartDate Start Date Yes #2
EndDate End Date Yes #3
Timezone Timezone Yes #4
TicketId Ticket ID No
Title Title No
Priority Priority No #5
Category Category No #6
Status Status No #7
CustomerId Customer ID No

 #1 < set value and explanation >
   001:Insert Date, 002:Update Date
   This parameter designates either insert date or update date for start/end date of search condition.
 #2 mm/dd/yyyy hh24:mi:ss
   < example >05/29/2016 00:00:00
 #3 mm/dd/yyyy hh24:mi:ss
   < example >05/30/2017 00:00:00
 #4 < set value and explanation >
   JST:JST(GMT+09:00)、UTC:UTC(GMT+00:00)
   This parameter designates the timezone of searching option’s start date and end date.
 #5 < set value and explanation >
   1:Critical, 2:Serious, 3:Medium, 4:Information
 #6 < set value and explanation >
   001:Analysis Report, 002:Periodic Report, 003:Other
 #7 < set value and explanation >
   001:Open, 002:Closed, 003:Deleted, 004:Inquiry, 005:Update

Example Request

GET /v1/mss/analysisportal/ticket-list?TargetDateEQ={TargetDateEQ}&StartDate={StartDate}&EndDate={EndDate}&Timezone={Timezone}&TicketId={TicketId}&Title={Title}&Priority={Priority}&Category={Category}&Status={Status}&CustomerId={CustomerId}

Response Parameters

Name Description Type  -
UpdateDate Update Date string
CustomerName Customer Name string
CustomerId Customer ID string
TicketId Ticket ID string
Category Category string #1
Priority Priority string #2
Title Title string
SubmitDate Submit Date string
Status Status string #3

 #1 < set value >
   Analysis Report, Periodic Report, Other
 #2 < set value >
   Critical, Serious, Medium, Information
 #3 < set value >
   Open, Closed, Deleted, Inquiry, Update

Example Result

{  
    "TicketList": [  
     {  
      "UpdateDate": "05/29/2017 08:17:29 UTC",  
      "CustomerName": "******",  
      "CustomerId": "******",  
      "TicketId": "1",  
      "Category": "Analysis Report",  
      "Priority": "Serious",  
      "Title": "Title******",  
      "SubmitDate": "05/29/2017 08:17:29 UTC",  
      "Status": "Open"  
    },  
    {  
      "UpdateDate": "05/29/2017 08:16:19 UTC",  
      "CustomerName": "******",  
      "CustomerId": "******",  
      "TicketId": "2",  
      "Category": "Analysis Report",  
      "Priority": "Serious",  
      "Title": " Title******”,  
      "SubmitDate": "05/29/2017 08:16:19 UTC",  
      "Status": "Open"  
    }  
  ]  
}  

Ticket Detail Reference

GET /v1/mss/analysisportal/ticket-detail

This API allows you to get ANALYSIS Portal’s ticket detail.

URL Query Parameter

Name Description Mandatory  -
TicketId Ticket ID Yes
CustomerId Customer ID Yes
AttachmentFlg Including attached files or not Yes #1

 #1 < set value and explanation >
   1:ON, 0:OFF

Example Request

GET /v1/mss/analysisportal/ticket-detail? TicketId={ TicketId }&CustomerId={ CustomerId }&AttachmentFlg={ AttachmentFlg }

Response Parameters

Name Description type  
TicketId Ticket ID string
Priority Priority string #1
Status Status string #2
CustomerName Customer Name  string
CustomerID Customer ID string
SubmitDate Submit Date string
UpdateDate Update Date string
Title Title string
Category Category string #3
TicketDescriotions[] Ticket Descriotion(array) -
*** UpdateDate Update Date string
*** Description Ticket History string
*** MailSendHistory Mail Send History string #4
*** PhoneCallHistory Phone Call History string #5
*** UpdateUserName Update User Name string
DeviceName Device Name string
AttachedFiles[] AttachedFiles(array) -
*** AttachFileData Attached File Data base64
*** AttachFileName Attached File Name string
TargetIpAddress Target IP Address string

 #1 < set value >
   Critical, Serious, Medium, Information
 #2 < set value >
   Open, Closed, Deleted, Inquiry, Update
 #3 < set value >
   Analysis Report, Periodic Report, Other
 #4 < set value and explanation >
   0:No, 1:Yes
 #5 < set value and explanation >
   0:No, 1:Yes
 

Example Result

{  
  "TicketId": "5220",  
  "Priority": "Serious",  
  "Status": "Update",  
  "CustomerName": "******",  
  "CustomerId": "******",  
  "SubmitDate": "05/29/2017 17:18:40 JST",  
  "UpdateDate": "06/06/2017 19:59:02 JST",  
  "Title": " Title******",  
  "Category": "Other",  
  "TicketDescriptions": [  
    {  
      "UpdateDate": "06/06/2017 19:59:02 JST",  
      "Description": "test",  
      "MailSendHistory": "0",  
      "PhoneCallHistory": "",  
      "UpdateUserName": "******"  
    },  
    {  
      "UpdateDate": "05/29/2017 17:18:40 JST",  
      "Description": "test",  
      "MailSendHistory": "0",  
      "PhoneCallHistory": "",  
      "UpdateUserName": "******"  
    }  
  ],  
  "DeviceName": "",  
  "AttacheFiles": [  
    {  
      "AttacheFileData": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",  
      "AttacheFileName": "sample_1497509801888001.txt"  
    }  
],  
  "TargetIpAddress": "x.x.x.x"  
}  

Ticket Attached File Reference

GET /v1/mss/analysisportal/ticket-attachments

This API allows you to get ANALYSIS Portal’s ticket attached files.

URL Query Parameter

Name Description Mandatory  -
TicketId Ticket ID Yes
AttachFileName Attached File Name Yes  #1

 #1 Multiple files can be set with comma:",".

Example Request

GET /v1/mss/analysisportal/ticket-attachments?TicketId={ TicketId }&AttachFileName={ AttachFileName }

Response Parameters

Name Description type  -
AttachedFiles[] Attached Files(array) -
***AttachFileData Attached File Data base64
***AttachFileName Attached File Name string

Example Result

{  
  "AttacheFiles": [  
    {  
      "AttacheFileData":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",  
      "AttacheFileName":"sample_1497509801888001.txt"  
    },  
    {  
      "AttacheFileData":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",  
      "AttacheFileName":"sample2_1497509801888001.txt"  
    }  
  ]  
}  

ABTI BlackList API

getABTIBlackList

POST /v1/abti/blacklist

To retrieve ABTI blacklist and graylist.

Request Parameters

no parameter

URL Query Parameter

no parameter

Example Request

POST /v1/abti/blacklist

Response Parameters

Name Description type -
Status status code number #1
URL_Black blacklist url string
URL_Gray graylist url string

#1 < set value and explanation >

status code explanation
200 OK
400 Bad Request
401 Unauthorized
404 Not Found
405 Method Not Allowed
500 Internal Server Error

Example Result

{  
    "Status": 200,  
    "Message":    {  
        "URL_Black":[  
            "http://abti-blacksample1.com/",  
            "http://abti-blacksample2.com/",  
            "http://abti-blacksample3.com/aaa.php",  
            "http://abti-blacksample4.com/bbb.php"  
        ],  
        "URL_Gray":[  
            "http://abti-graysample1.com/",  
            "http://abti-graysample2.com/",  
            "http://abti-graysample3.com/aaa.php",  
            "http://abti-graysample4.com/bbb.php"  
        ]  
    }  
}