WideAngle API

Overview

 本APIでは、WideAngle MSSの契約マスタ情報の取得/更新、チケット情報の取得、およびABTIブラックリストの取得を行うことが可能です。WideAngle MSSは以下のAPIを提供します。

契約マスタAPI

API Description
サービスマスタ取得 サービスマスタを取得します。
脆弱性診断サービスマスタ取得 脆弱性診断サービスマスタを取得します。
機器マスタ取得 機器マスタを取得します。
機器工事マスタ取得 機器工事マスタを取得します。
ライセンスマスタ取得 ライセンスマスタを取得します。
保守マスタ取得 保守マスタを取得します。
オプションマスタ取得 オプションマスタを取得します。
契約案件一覧取得 契約案件一覧を取得します。
契約案件詳細取得 契約案件詳細を取得します。
CHB基本情報一覧取得 CHB基本情報一覧を取得します。
CHB基本情報詳細取得 CHB基本情報詳細を取得します。
CHB基本情報更新 CHB基本情報を更新します。

チケット取得API

API Description
チケット一覧取得 チケット一覧を取得します。
チケット詳細取得 指定したチケットの詳細情報を取得します。
チケット添付ファイル取得 指定したチケットに添付されているファイルを取得します。

ABTIブラックリスト取得API

API Description
ABTIブラックリスト取得 ABTIブラックリストを取得します。

Resource URL

 グローバル共通ドメイン、または個別リージョンドメインをご利用ください。
グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、一番近いAPIゲートウェイに接続します。

1.Base Path(Global Load Balance)
契約マスタAPI : https://api.ntt.com/v1/mss/contract/master/
チケット取得API: https://api.ntt.com/v1/mss/analysisportal/
ABTIブラックリスト取得API: https://api.ntt.com/v1/abti/

2.Base Path(Region)
契約マスタAPI : https://{region}.api.ntt.com/v1/mss/contract/master/
チケット取得API: https://{region}.api.ntt.com/v1/mss/analysisportal/
ABTIブラックリスト取得API: https://{region}.api.ntt.com/v1/abti/

‧ region : jp|us|uk
‧ e.g. https://us.api.ntt.com/v1/mss/contract/master/

契約マスタAPI

サービスマスタ取得

GET /v1/mss/contract/master/service?secretKey={秘密キー}

サービスマスタを取得します。

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes
offset 開始位置 query argument No 0 ※先頭から
limit 最大値 query argument No 300

Example Request

GET /v1/mss/contract/master/service?secretKey={秘密キー}&offset={開始位置}&limit={最大値}

Response Parameters

Name Description type
result 取得要素数 number
offset 取得開始位置 number
total 全体用素数 number
name サービス名 string
initialCost サービス初期費 お客さま提供価格 number
monthlyCost サービス月額料金 お客さま提供価格 number
operationLevel オペレーションレベル string
serviceMenu1 サービスメニュー1 string
serviceMenu2 サービスメニュー2 string
serviceSize サービスサイズ string

Example Result

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

脆弱性診断サービスマスタ取得

GET /v1/mss/contract/master/assessment-service?secretKey={秘密キー}

脆弱性診断サービスマスタを取得します。

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes
offset 開始位置 query argument No 0 ※先頭から
limit 最大値 query argument No 300

Example Request

GET /v1/mss/contract/master/assessment-service?secretKey={秘密キー}&offset={開始位置}&limit={最大値}

Response Parameters

Name Description type
result 取得要素数 number
offset 取得開始位置 number
total 全体用素数 number
ip IP数 number
standardPrice 標準メニュー料金 number
inspectionPrice 誤検知検査料金 number
scanPrice クレデンシャルスキャン料金 number
reportPrice 報告書料金 number
attachmentPrice 別紙:検出結果一覧料金 number
mediaPrice メディア納品料金 number
printPrice 印刷物納品料金 number
conferencePrice 報告会料金 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
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

機器マスタ取得

GET /v1/mss/contract/master/device?secretKey={秘密キー}

機器マスタを取得します。

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes
offset 開始位置 query argument No 0 ※先頭から
limit 最大値 query argument No 300

Example Request

GET /v1/mss/contract/master/device?secretKey={秘密キー}&offset={開始位置}&limit={最大値}

Response Parameters

Name Description type
result 取得要素数 number
offset 取得開始位置 number
total 全体用素数 number
deviceName 機器品名 string
deviceType デバイスタイプ string
deviceModel デバイスモデル string
purchasePrice 機器費(お買上げ)お客さま提供価格 number
rentalPrice 機器費(レンタル)お客さま提供価格 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
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

機器工事マスタ取得

GET /v1/mss/contract/master/device-construction?secretKey={秘密キー}

機器工事マスタを取得します。

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes
offset 開始位置 query argument No 0 ※先頭から
limit 最大値 query argument No 300

Example Request

GET /v1/mss/contract/master/device-construction?secretKey={秘密キー}&offset={開始位置}&limit={最大値}

Response Parameters

Name Description type
result 取得要素数 number
offset 取得開始位置 number
total 全体用素数 number
deviceConstructionName 機器工事名 string
deviceType デバイスタイプ string
constructionPrice 機器工事費お客さま提供価格 number

Example Result

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

ライセンスマスタ取得

GET /v1/mss/contract/master/license?secretKey={秘密キー}

ライセンスマスタを取得します。

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes
offset 開始位置 query argument No 0 ※先頭から
limit 最大値 query argument No 300

Example Request

GET /v1/mss/contract/master/license?secretKey={秘密キー}&offset={開始位置}&limit={最大値}

Response Parameters

Name Description type
result 取得要素数 number
offset 取得開始位置 number
total 全体用素数 number
licenseName 機器ライセンス品名 string
deviceType デバイスタイプ string
deviceModel デバイスモデル string
licensePrice 機器ライセンス費お客さま提供価格 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
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

保守マスタ取得

GET /v1/mss/contract/master/maintenance?secretKey={秘密キー}

保守マスタを取得します。

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes
offset 開始位置 query argument No 0 ※先頭から
limit 最大値 query argument No 300

Example Request

GET /v1/mss/contract/master/maintenance?secretKey={秘密キー}&offset={開始位置}&limit={最大値}

Response Parameters

Name Description type
result 取得要素数 number
offset 取得開始位置 number
total 全体用素数 number
maintenanceName 機器保守品名 string
deviceType デバイスタイプ string
deviceModel デバイスモデル string
maintenancePrice 機器保守費お客さま提供価格 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
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

オプションマスタ取得

GET /v1/mss/contract/master/option?secretKey={秘密キー}

オプションマスタを取得します。

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes
offset 開始位置 query argument No 0 ※先頭から
limit 最大値 query argument No 300

Example Request

GET /v1/mss/contract/master/option?secretKey={秘密キー}&offset={開始位置}&limit={最大値}

Response Parameters

Name Description type
result 取得要素数 number
offset 取得開始位置 number
total 全体用素数 number
optionName オプションサービス名 string
deviceType デバイスタイプ string
optionInitialPrice オプションサービス初期費お客さま提供価格 number
optionMonthlyPrice オプションサービス月額費お客さま提供価格 number

Example Result

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

契約案件一覧取得

GET /v1/mss/contract/contract-project?secretKey={秘密キー}

契約案件一覧を取得します。

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes
offset 開始位置 query argument No 0 ※先頭から
limit 最大値 query argument No 300

Example Request

GET /v1/mss/contract/contract-project?secretKey={秘密キー}&offset={開始位置}&limit={最大値}

Response Parameters

Name Description type
result 取得要素数 number
offset 取得開始位置 number
total 全体用素数 number
contractProjectID 契約案件ID string
contractProjectName 契約案件名 string

Example Result

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

契約案件詳細取得

GET /v1/mss/contract/contract-project/{契約案件ID}?secretKey={秘密キー}

契約案件詳細を取得します。

Request Parameters

URL Path Parameter

Description | Type | Mandatory
契約案件ID | string | Yes

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes

Example Request

GET /v1/mss/contract/contract-project/{契約案件ID}?secretKey={秘密キー}

Response Parameters

Name Description type
contractProjectID 契約案件ID string
contractProjectName 契約案件名 string
contractorName 契約者名 string
contractPeriod 契約期間(月数) number
orderDate 受注日 string (yyyymmdd)
commonCustomerID 共通顧客ID(C番) string
offerStartDate 提供開始日 string (yyyymmdd)
offerEndDate 提供終了予定日 string (yyyymmdd)
projectManagementNum 案件管理番号(契約ID) string
resaleClientName 再販先・再受託元お客さま名 string
notices 契約上の特記事項 string
detailsNum 契約案件明細数 number
contractDetailsID 契約案件明細番号 string
recordType レコードタイプ string
baseAdress 拠点(設置場所)住所 string
baseCountry 拠点(設置場所)国 string
baseIdentifier 拠点(設置場所)識別子 string
clientVM クライアント数・VM数 number
connLineType 管理接続 回線種別 string
deviceDeliveryDate 機器納品日 string (yyyymmdd)
deviceOfferType 機器提供形態 string
deviceOffer 機器提供有無 string
deviceType デバイスタイプ string
HA HA構成 string
otherModel デバイスモデルその他の場合のモデル名 string
otherServiceName サービスその他の場合のサービス名 string
serviceNotices サービス特約事項 string
serviceEndDate サービス提供終了日 string (yyyymmdd)
servicePeriod サービス提供期間(月数) number
serviceStartDate サービス提供開始日 string (yyyymmdd)
service サービス名 string
construction 機器工事名 string
otherName その他の場合の名称 string
device 機器品名 string
deviceHost 機器ホスト名 string
deviceIp 機器IPアドレス string
deviceNum 機器台数 number
offerPeriod 提供期間 number
deviceInstallationDate 機器設置日 string (yyyymmdd)
license 機器ライセンス品名 string
StartDate 開始日 string (yyyymmdd)
EndDate 終了日 string (yyyymmdd)
maintenance 機器保守品名 string
maintenanceType 機器保守種別 string
option オプションサービス名 string
module 機器モジュール品名 string
moduleModel 機器モジュール型番 string
moduleNum 機器モジュール台数 number
remoteIp リモート診断IP数 number
onsiteIp オンサイト診断IP数 number
asopInspection 誤検知検査 number(0:FALSE, 1:TRUE)
asopScan クレデンシャルスキャン number(0:FALSE, 1:TRUE)
asopReport 報告書 number(0:FALSE, 1:TRUE)
asopAttachment 別紙:検出結果一覧 number(0:FALSE, 1:TRUE)
asopMedia メディア納品 number(0:FALSE, 1:TRUE)
asopPrint 印刷物納品 number(0:FALSE, 1:TRUE)
asopConference 報告会 number(0:FALSE, 1:TRUE)
asopOtherName その他料金項目名 string
asopStartDate1 診断希望1開始日 string (yyyymmdd)
asopEndDate1 診断希望1終了日 string (yyyymmdd)
asopStartDate2 診断希望2開始日 string (yyyymmdd)
asopEndDate2 診断希望2終了日 string (yyyymmdd)
asopRequest お客さまご要望等 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"
        },  
        ・・・ 取得項目数分 ・・・  
    ]       
}

CHB基本情報一覧取得

GET /v1/mss/contract/chb?secretKey={秘密キー}

CHB基本情報一覧を取得します。

Request Parameters

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes
offset 開始位置 query argument No 0 ※先頭から
limit 最大値 query argument No 300

Example Request

GET /v1/mss/contract/chb?secretKey={秘密キー}&offset={開始位置}&limit={最大値}

Response Parameters

Name Description type
result 取得要素数 number
offset 取得開始位置 number
total 全体用素数 number
entries 取得要素 array
projectManagementNum 案件管理番号(契約ID) string
projectName 案件名 string

Example Result

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

CHB基本情報詳細取得

GET /v1/mss/contract/chb/{案件管理番号(契約ID)}?secretKey={秘密キー}

CHB基本情報詳細を取得します。

Request Parameters

URL Path Parameter

Description | Type | Mandatory
案件管理番号(契約ID) | string | Yes

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes

Example Request

GET /v1/mss/contract/chb/{案件管理番号(契約ID)}?secretKey={秘密キー}

Response Parameters

Name Description type
version 電文バージョン string
projectManagementNum 案件管理番号(契約ID) string
projectName 案件名 string
offerForm 提供形態 string
passPhrase パスフレーズ string
contractNumber 契約案件番号 string
contactPerson コンタクトパーソン array
contactPersonNo コンタクトパーソン番号 number (1~6)
enableFlag 有効化 number (0~1)
conpanyName 会社名 string
groupName 担当者氏名または部署名 string
groupNameKana 担当者氏名または部署名の読み仮名 string
socNoticeTel1 SOCからの連絡先電話番号①(優先) string
socNoticeTel2 SOCからの連絡先電話番号② string
senderMailAddress 送信者メールアドレス(送信元認証あり) string
weekdayContactOrder 平日の日勤帯の電話連絡順 number (1~6)
exceptWdayConOrder 平日の日勤帯以外の電話連絡順 number (1~6)
workTime 「日勤帯」の定義 array
workTimeStart 始業時刻 string
workTimeEnd 終業時刻 string
noticeMail 通知先メールアドレス array
socNoticeMail SOCからの通知先メールアドレス string
csPortalTicketMail カスタマーポータルのチケット通知先メールアドレス string
csPortalAccount カスタマーポータル接続先アカウント情報 array
guideMail カスタマーポータル接続認証のご案内を受信するメールアドレス string
connUrl 接続URL string
reportSchedule 月次レポートのスケジュール string
customerName お客さま名(会社名) string
customerNameEN お客さま名(会社名)の英語表記 string
commonCustomerID 共通顧客ID(C番) string
resaleClientName 再販先.再受託元のお客様名 string
countryName 国名(A-END) string
timeZone タイムゾーン string
remarks 備考 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"
}    

CHB基本情報更新

POST /v1/mss/contract/chb/{案件管理番号(契約ID)}?secretKey={秘密キー}

CHB基本情報を更新します。

Request Parameters

URL Path Parameter

Description | Type | Mandatory
案件管理番号(契約ID) | string | Yes

URL Query Parameter

Name Description Type Mandatory Default
secretKey 秘密キー query argument Yes

Body

Name Description Type Mandatory
version 電文バージョン string
contactPerson コンタクトパーソン array
contactPersonNo コンタクトパーソンNo number (1~6)
conpanyName 会社名 string
groupName 担当者氏名または部署名 string
groupNameKana 担当者氏名または部署名の読み仮名 string
socNoticeTel1 SOCからの連絡先電話番号①(優先) string
socNoticeTel2 SOCからの連絡先電話番号② string
senderMailAddress 送信者メールアドレス(送信元認証あり) string
weekdayContactOrder 平日の日勤帯の電話連絡順 string
exceptWdayConOrder 平日の日勤帯以外の電話連絡順 string
workTime 「日勤帯」の定義 array
workTimeStart 始業時刻 string
workTimeEnd 終業時刻 string

注意: JSONリクエストであるため、リクエストヘッダに Content-Type: application/json を指定すること。

Example Request

    POST /v1/mss/contract/chb/{案件管理番号(契約ID)}?secretKey={秘密キー}

{
    "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 電文バージョン string
result 結果 string
errMessage エラーメッセージ string

Example Response

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

チケット取得API

チケット一覧取得

GET /v1/mss/analysisportal/ticket-list

ANALYSIS Portalのチケット情報一覧を取得します。

URL Query Parameter

Name Description Mandatory  -
TargetDateEQ 対象日時 Yes #1
StartDate 開始日時 Yes #2
EndDate 終了日時 Yes #3
Timezone タイムゾーン Yes #4
TicketId チケットID No
Title タイトル No
Priority プライオリティ No #5
Category カテゴリ No #6
Status ステータス No #7
CustomerId お客様ID No

 #1 <候補値とその説明>
   001:作成日時、002:更新日時
   検索条件の開始日時と終了日時を作成日時か更新日時に指定する。
 #2 mm/dd/yyyy hh24:mi:ss
   <値の例>05/29/2016 00:00:00
 #3 mm/dd/yyyy hh24:mi:ss
   <値の例>05/30/2017 00:00:00
 #4 <候補値とその説明>
   JST:JST(GMT+09:00)、UTC:UTC(GMT+00:00)
   検索条件の開始日時と終了日時のタイムゾーンを指定する。
 #5 <候補値とその説明>
   1:Critical,2:Serious,3:Medium,4:Information
 #6 <候補値とその説明>
   001:Analysis Report、002:Periodic Report、003:Other
 #7 <候補値とその説明>
   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 変更日時 string
CustomerName お客様名 string
CustomerId お客様ID string
TicketId チケットID string
Category カテゴリ string #1
Priority プライオリティ string #2
Title タイトル string
SubmitDate 作成日時 string
Status ステータス string #3

 #1 <候補値>
   Analysis Report, Periodic Report, Other
 #2 <候補値>
   Critical, Serious, Medium, Information
 #3 <候補値>
   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"  
     }  
   ]  
}  

チケット詳細取得

GET /v1/mss/analysisportal/ticket-detail

ANALYSIS Portalのチケット詳細を取得します。

URL Query Parameter

Name Description Mandatory  -
TicketId チケットID Yes
CustomerId カスタマID Yes
AttachmentFlg 添付ファイル有無 Yes #1

 #1 <候補値とその説明>
   1:ON, 0:OFF

Example Request

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

Response Parameters

Name Description type  -
TicketId チケットID string
Priority プライオリティ string #1
Status ステータス string #2
CustomerName お客様名  string
CustomerID お客様ID string
SubmitDate 作成日時 string
UpdateDate 更新日時 string
Title タイトル string
Category カテゴリ string #3
TicketDescriotions[] 内容(配列) -
*** UpdateDate 更新日時 string
*** Description 履歴 string
*** MailSendHistory メール送信履歴 string #4
*** PhoneCallHistory 電話通知履歴 string #5
*** UpdateUserName 更新者 string
DeviceName デバイス string
AttachedFiles[] 添付ファイル(配列) -
*** AttachFileData 添付ファイルデータ base64形式
*** AttachFileName 添付ファイル名 string
TargetIpAddress ターゲットIPアドレス string

 #1 <候補値>
   Critical, Serious, Medium, Information
 #2 <候補値>
   Open, Closed, Deleted, Inquiry, Update
 #3 <候補値>
   Analysis Report, Periodic Report, Other
 #4 <候補値とその説明>
   0:なし, 1:あり
 #5 <候補値とその説明>
   0:なし, 1:あり
 

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"  
 }  

チケット添付ファイル取得

GET /v1/mss/analysisportal/ticket-attachments

チケットの添付ファイルを取得します。

URL Query Parameter

Name Description Mandatory  -
TicketId チケットID Yes
AttachFileName 添付ファイル名 Yes #1

 #1 カンマ区切りで複数ファイル指定可能。

Example Request

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

Response Parameters

Name Description type  -
AttachedFiles[] 添付ファイル(配列) -
***AttachFileData 添付ファイルデータ base64形式
***AttachFileName 添付ファイル名 string

Example Result

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

ABTIブラックリスト取得API

ABTI ブラックリスト取得

POST /v1/abti/blacklist

      
ABTIブラックリスト、グレーリストを取得します。

Request Parameters

なし

URL Query Parameter

なし

Example Request

POST /v1/abti/blacklist

Response Parameters

Name Description type -
Status ステータスコード number #1
URL_Black ブラックリストURL string
URL_Gray グレーリストURL string

#1 <候補値とその説明>

ステータスコード 説明
200 OK(正常終了)
400 Bad Request(リクエストURL不正)
401 Unauthorized(ABTI認証エラー)
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"  
        ]  
    } 
}