GetIncidentDetail

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

HTTPメソッド	Action	名称
POST	GetIncidentDetail	インシデント詳細取得

1：リクエストパラメータ

パラメータ	タイプ	必須	意味	最大文字数	リクエスト例	備考
OfficeId	String	○	事業者コード	11	IIJ00000001	固定
ServiceCode	String	○	サービスコード	15	uom12345678	ご契約のサービスコードを指定してください
MasterId	String	○	申請者マスターID	15	SA9876543	マスターIDを指定してください
IncidentId	String[]	−	チケット番号	15	UTM123456	詳細情報を取得するチケット番号を指定してください
AssignUserId	String[]	−	担当者ID	15	SA1234567	チケットに割り当てる担当者のマスターIDを指定してください
StateCode	String[]	−	ステータスコード	3	000	以下から指定してください 000：未対応 100：対応中 200：クローズ
NodeName	String[]	−	ノード名	1024	testnode_001	ノード名を指定してください
EventId	String	−	イベントID	256	1234	イベントIDを指定してください
ObstacleDetectionTimeFrom	String	−	障害検知日時from	14	20160710120000	障害検知日時の開始日時をYYYYMMDDhhmmssの形式で指定してください
ObstacleDetectionTimeTo	String	−	障害検知日時To	14	20160720120000	障害検知日時の完了日時をYYYYMMDDhhmmssの形式で指定してください
CorrespondStartDateFrom	String	−	対応開始日時 from	14	20160710120000	対応開始日時の開始日時をYYYYMMDDhhmmssの形式で指定してください
CorrespondStartDateTo	String	−	対応開始日時 to	14	20160720120000	対応開始日時の完了日時をYYYYMMDDhhmmssの形式で指定してください
ListMaxRecords	String	○	取得リスト最大件数	5	3000	取得リストの最大数を指定してください
Locale	String	○	表示言語	1	0	下記のみ利用可能です 0：日本語

2：レスポンス

正常終了

フィールド			タイプ	意味	備考
StatusCode			String	ステータスコード	成功時200が返却されます
Result			−	結果
	RequestId		String	リクエストID	APIリクエストごとに割り当てられる一意なIDです
	NumberList		Array	件数リスト
		Number	String	件数	ステータスコードごとの取得リスト件数が返却されます
		StateCode	String	ステータスコード	以下が返却されます 000：未対応 100：対応中 200：クローズ
	TicketList		Array	チケットリスト	チケット情報を格納したリストです
		IncidentId	String	チケット番号	チケット番号です
		StateCode	String	ステータスコード	以下が返却されます 000：未対応 100：対応中 110：復旧済み 120：クローズ承認待ち 130：差し戻し 200：クローズ
		ReceivingTime	String	検知日時	形式：YYYYMMDDhhmmss
		TicketType	String	チケット種別	以下が返却されます 0：チケット管理の画面から作成されたインシデント 1：上記以外のインシデント
		ParFlg	String	親フラグ	以下が返却されます 0：関連付けされたチケット 1：マスターチケット 2：関連付けなし
		DelFlg	String	削除フラグ	以下が返却されます 0：有効 1：削除済み
		NodeName	String	ノード名	運用対象ノード名が返却されます
		DetectionMessage	String	検知メッセージ	障害情報の受付メッセージが返却されます
		ObstacleDetectionTime	String	障害検知日時	形式：YYYYMMDDhhmmss
		MessageManagerId	String	メッセージ管理ID	インシデントのメッセージの管理IDが返却されます
		EventId	String	イベントID	監視IDが返却されます
		MessageGroup	String	メッセージグループ	インシデントメッセージのグループです
		Explanation	String	説明
		SurveillanceServer	String	監視サーバ	監視サーバ名が返却されます
		MessageId	String	メッセージID	インシデントのメッセージIDです
		MessageObject	String	メッセージオブジェクト	メッセージの内容が返却されます
		OriginalMessage	String	オリジナルメッセージ	元のメッセージ内容が返却されます
		MessageStatus	String	メッセージステータス	メッセージの状態が返却されます
		AlertChangeContent	String	アラート変更内容	アラートの変更内容が返却されます
		NodeTitle	String	ノード名称	先頭に”サービスコード_”を含まない、運用対象ノード名が返却されます
		MonitoringName	String	監視名称	監視の名称が返却されます
		UserId	String	担当者ID	担当者のマスターIDを返却します
		StartDate	String	期間開始日	形式: YYYYMMDDhhmmss
		FinishDate	String	期間完了日	形式: YYYYMMDDhhmmss
		Title	String	チケット件名	チケットに付与されたチケット件名が返却されます
		CorrespondStartDate	String	対応開始日時	形式: YYYYMMDDhhmmss
		CorrespondFinishDate	String	対応終了日時	形式: YYYYMMDDhhmmss
		CorresopndOutline	String	対応概要	対応状況の概要に設定された内容が返却されます
		Cause	String	原因	対応状況の原因に設定された内容が返却されます
		Influence	String	影響	対応状況の影響に設定された内容が返却されます
		Measure	String	対策	対応状況の対策に設定された内容が返却されます
		CorrespondProcessUserId	String	担当者ID	対応メモに紐付く担当者のマスターIDを返却します
		UserName	String	担当者氏名	対応メモに紐付く担当者の氏名を返却します
		CorrespondProcess	String	対応メモ	対応メモの内容が返却されます
		AssignUserId	String	担当者ID	インシデントに割り当てられた担当者のマスターIDを返却します
		AssignUserName	String	担当者氏名	インシデントに割り当てられた担当者の氏名を返却します
		AssignDate	String	割当日時	形式: YYYYMMDDhhmmss
		AssignReleaseDate	String	割当解除日時	形式: YYYYMMDDhhmmss
		MasterIncidentId	String	マスターチケット番号	関連付けられたチケットの上位のチケット番号です
		RelateDate	String	関連付け日時	形式: YYYYMMDDhhmmss
		RelateReleaseDate	String	関連解除日時	形式: YYYYMMDDhhmmss
		IncidentStateInsertDate	String	インシデントステータス登録日時	形式: YYYYMMDDhhmmss
		IncidentStateUpdateDate	String	インシデントステータス更新日時	形式: YYYYMMDDhhmmss
		CorrespondInsertDate	String	お客様対応記載登録日時	形式: YYYYMMDDhhmmss
		CorrespondUpdateDate	String	お客様対応記載更新日時	形式: YYYYMMDDhhmmss

異常終了

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

3：エラーメッセージ

エラー

HTTP Status Code

ErrorType

ErrorMessage

説明

パラメータエラー

200

UOMParameterError

UOM parameter error occurred.

指定されたパラメータが誤っています

最大文字数を超過している
指定する形式が誤っている
必須パラメータが指定されていない

など

例外エラー

200

UOMExceptionError

UOM system exception error occurred.

UOM-API設備のシステム障害

共通エラーについて詳しくは、「UOM-APIのエラー」をご覧ください。

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 = "GetIncidentDetail"
PARAMS = '{
	"OfficeId" : "IIJ00000001",
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"IncidentId" : ["UTM123456","UTM123457","UTM123458"],
	"AssignUserId" : ["SA9876543","SA1234567"],
	"StateCode" : ["000","100","200"],
	"NodeName" : ["testnode_001","testnode_002"],
	"EventId" : "1234"
	"ObstacleDetectionTimeFrom" : "20170707101030",
	"ObstacleDetectionTimeTo" : "20170720101030",
	"CorrespondStartDateFrom" : "20170707101030",
	"CorrespondStartDateTo" : "20170720101030",
	"ListMaxRecords" : "3000",
	"Locale" : "0"
}'

レスポンス（XML）

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

レスポンス（JSON）

正常終了
{
	"GetIncidentDetailResponse":{
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"NumberList":[
			{"Number":"1","StateCode":"000"},
			{"Number":"5","StateCode":"100"},
			{"Number":"0","StateCode":"200"}
		],
		"TicketList":[
			{"AlertChangeContent":"",
			"CorrespondOutline":"",
			"RelateReleaseDate":"",
			"CorrespondUpdateDate":"",
			"CorrespondStartDate":"20160910000000",
			"MessageGroup":"",
			"CorrespondInsertDate":"20160910153836",
			"EventId":"-",
			"UserName":"",
			"MasterIncidentId":"",
			"ObstacleDetectionTime":"20160910000000",
			"Measure":"",
			"AssignReleaseDate":"",
			"StateCode":"100",
			"Influence":"",
			"CorrespondProcessUserId":"",
			"DetectionMessage":"",
			"StartDate":"20160910000000",
			"MessageId":"",
			"CorrespondProcess":"",
			"CorrespondFinishDate":"",
			"MessageManagerId":"",
			"Explanation":"",
			"AssignUserName":"IIJ太郎",
			"NodeName":"-",
			"OriginalMessage":"",
			"RelateDate":"",
			"IncidentStateUpdateDate":"20160914165328",
			"NodeTitle":"",
			"FinishDate":"",
			"SurveillanceServer":"",
			"UserId":"",
			"ParFlg":"1",
			"AssignUserId":"SA9876543",
			"MonitoringName":"",
			"Title":"インシデント作成XXXXXXX",
			"IncidentId":"",
			"AssignUserDate":"20160914154742",
			"TicketType":"0",
			"MessageObject":"",
			"MessageStatus":"",
			"IncidentStateInsertDate":"20160914142510",
			"Cause":"",
			"DelFlg":"0"}
		]
	}
}
異常終了
{
	"ErrorResponse":{
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"ErrorType":"UOMWebSystemError",
		"ErrorMessage":"UOM Web System error occurred."
	}
}

公開
マニュアル一覧へ

ご契約者向け
マニュアル一覧へ

GetIncidentDetail

1：リクエストパラメータ

2：レスポンス

正常終了

異常終了

3：エラーメッセージ

4：警告メッセージ

5：制限

6：サンプル（REST形式）

config.rb

レスポンス（XML）

レスポンス（JSON）

GetIncidentDetail

1： リクエストパラメータ

2： レスポンス

正常終了

異常終了

3： エラーメッセージ

4：警告メッセージ

5：制限

6：サンプル（REST形式）

config.rb

レスポンス（XML）

レスポンス（JSON）

1：リクエストパラメータ

2：レスポンス

3：エラーメッセージ