GetIncidentSummary

「UOMポータル」の「チケット管理」と同様に、現在のインシデント情報のサマリを取得できます。

HTTPメソッドAction名称
POSTGetIncidentSummaryインシデントサマリ取得
1: リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
OfficeIdString事業者コード11IIJ00000001固定
ServiceCodeStringサービスコード15uom12345678ご契約のサービスコードを指定してください
MasterIdString申請者マスターID15SA9876543マスターIDを指定してください
StateCodeString[]ステータスコード3000

以下から指定してください

000:未対応

100:対応中

200:クローズ

ParFlgString[]親フラグ11

以下から指定してください

2:関連付けなし

1:マスターチケット

0:関連付けされたチケット

ObstacleDetectionTimeFromString障害検知日時from1420170707101030YYYYMMDDhhmmssの形式で指定してください
ObstacleDetectionTimeToString障害検知日時To1420170720101030YYYYMMDDhhmmssの形式で指定してください
ListMaxRecordsString取得リスト最大件数53000取得リストの最大数を指定してください
LocaleString表示言語10

下記のみ利用可能です

0:日本語

2: レスポンス
正常終了
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時200が返却されます
Result 結果 
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
NumberList Array件数リスト 
NumberString件数ステータスコードごとの取得リスト件数が返却されます
StateCodeStringステータスコード

以下が返却されます

000:未対応

100:対応中

200:クローズ

TicketList Arrayチケットリストチケット情報を格納したリストです
IncidentIdStringチケット番号チケット番号です
StateCodeStringステータスコード

以下が返却されます

000:未対応

100:対応中

200:クローズ

ReceivingTimeString検知日時形式:YYYYMMDDhhmmss
TicketTypeStringチケット種別

以下が返却されます

0:新規作成されたチケット

1:上記以外のチケット

ParFlgString親フラグ

以下が返却されます

2:関連付けなし

1:マスターチケット

0:関連付けされたチケット

DelFlgString削除フラグ

以下が返却されます

0:有効

1:削除済み

NodeNameStringノード名運用対象ノード名が返却されます
DetectionMessageString検知メッセージ障害情報の受付メッセージが返却されます
ObstacleDetectionTimeString障害検知日時形式:YYYYMMDDhhmmss
EventIdStringイベントID障害情報の監視IDが返却されます
MessageManagerIdStringメッセージ管理IDインシデントのメッセージの管理IDが返却されます
StartDateString期間開始日形式:YYYYMMDDhhmmss
FinishDateString期間完了日形式:YYYYMMDDhhmmss
TitleStringタイトルチケットに付与されたタイトルが返却されます
AssignUserIdString担当者IDチケットに担当者が割り当てられている場合、担当者のマスターIDが返却されます
AssignUserNameString担当者氏名チケットに担当者が割り当てられている場合、担当者の氏名が返却されます
AssignUserDateString割当日時形式:YYYYMMDDhhmmss
MasterIncidentIdStringマスターチケット番号関連付けられたチケットの上位のチケット番号です
RelateDateString関連付け日時形式:YYYYMMDDhhmmss

異常終了
フィールドタイプ意味備考
Result 結果 
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ErrorTypeStringエラータイプ異常終了となったエラータイプです
ErrorMessageStringエラーメッセージ異常終了となったエラーメッセージです

3: エラーメッセージ
エラーHTTP Status CodeErrorTypeErrorMessage説明備考

パラメータエラー

400Parameter ErrorThere are invalid parameters.パラメータの形式が無効 

Webシステムエラー

500UOM WebSystem ErrorUOM Web System error occurred.システム障害 
4:警告メッセージ

なし

5:制限

なし

6:サンプル(REST形式)
config.rb
##
## 個別設定
##

# API のキー設定
IIJAPI_ACCESS_KEY = "1234567890ABCDEFGHIJ"
IIJAPI_SECRET_KEY = "1234567890ABCDEFGHIJabcdefghijklmnopqr+1"

##
## API の基本設定
##

# API の ENDPOINT 設定
IIJAPI_ENDPOINT = https://uom.api.iij.jp
IIJAPI_SSL_NO_VERIFY = true

# API バージョンの設定
APIVERSION = "20161003"

# Content-Type の設定
CONTENTTYPEVALUE = "application/json; charset=utf-8"

# インシデントサマリ取得
# 以下の内容は、適宜修正してください。
ACTION = "GetIncidentSummary"
PARAMS = '{
	"OfficeId" : "IIJ00000001",
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"StateCode" : ["000","100","200"],
	"ParFlg" : ["2","1","0"],
	"ObstacleDetectionTimeFrom" : "20170707101030",
	"ObstacleDetectionTimeTo" : "20170720101030",
	"ListMaxRecords" : "3000",
	"Locale" : "0"
}'
レスポンス(XML)

本APIでは、XMLでのリクエストを許可していません。

レスポンス(JSON)
正常終了
{
	"GetIncidentSummaryResponse":{
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"NumberList":[
			{"Number":"1","StateCode":"000"},
			{"Number":"1","StateCode":"100"},
			{"Number":"0","StateCode":"200"}
		],
		"TicketList":[
			{"RelateDate":"",
			"EventId":"-",
			"FinishDate":"",
			"MasterIncidentId":"",
			"ObstacleDetectionTime":"20160910000000",
			"ParFlg":"2",
			"AssignUserId":"SA1234567",
			"StateCode":"000",
			"Title":"",
			"IncidentId":"IM123456",
			"DetectionMessage":"",
			"StartDate":"",
			"AssignUserDate":"",
			"MessageManagerId":"",
			"TicketType":"1",
			"AssignUserName":"",
			"NodeName":"-",
			"DelFlg":"0"},
			{"RelateDate":"",
			"EventId":"45962",
			"FinishDate":"",
			"MasterIncidentId":"",
			"ObstacleDetectionTime":"20160910000000",
			"ParFlg":"0",
			"AssignUserId":"SA1234567",
			"StateCode":"100",
			"Title":"インシデントXXXX",
			"IncidentId":"",
			"DetectionMessage":"",
			"StartDate":"20160910000000",
			"AssignUserDate":"20160910161158",
			"MessageManagerId":"",
			"TicketType":"0",
			"AssignUserName":"XXXX XXXX",
			"NodeName":"-",
			"DelFlg":"0"}
		]
	}
}
異常終了
{
	"ErrorResponse":{
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"ErrorType":"UOMWebSystemError",
		"ErrorMessage":"UOM Web System error occurred."
	}
}