GetIncidentDetail

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

HTTPメソッドAction名称
POSTGetIncidentDetailインシデント詳細取得
1: リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
OfficeIdString事業者コード11IIJ00000001固定
ServiceCodeStringサービスコード15uom12345678ご契約のサービスコードを指定してください
MasterIdString申請者マスターID15SA9876543マスターIDを指定してください
IncidentIdString[]チケット番号15IM1234567詳細情報を取得するチケット番号を指定してください
AssignUserIdString[]担当者ID15SA1234567チケットに割り当てる担当者のマスターIDを指定してください
StateCodeString[]ステータスコードObstacleDetectionTimeTo3000

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

000:未対応

100:対応中

200:クローズ

 NodeNameString[] ノード名1024testnode_001 ノード名を指定してください
 EventIdStringイベントID2561234イベントIDを指定してください 
ObstacleDetectionTimeFromString障害検知日時from1420160710120000障害検知日時の開始日時をYYYYMMDDhhmmssの形式で指定してください
ObstacleDetectionTimeToString障害検知日時To1420160720120000障害検知日時の完了日時をYYYYMMDDhhmmssの形式で指定してください
CorrespondStartDateFromString対応開始日時 from1420160710120000対応開始日時の開始日時をYYYYMMDDhhmmssの形式で指定してください
CorrespondStartDateToString対応開始日時 to1420160720120000対応開始日時の完了日時をYYYYMMDDhhmmssの形式で指定してください
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
MessageManagerIdStringメッセージ管理IDインシデントのメッセージの管理IDが返却されます
EventIdStringイベントID監視IDが返却されます
MessageGroupStringメッセージグループインシデントメッセージのグループです
ExplanationString説明 
SurveillanceServerString監視サーバ監視サーバ名が返却されます
MessageIdStringメッセージIDインシデントのメッセージIDです
MessageObjectStringメッセージオブジェクトメッセージの内容が返却されます
OriginalMessageStringオリジナルメッセージ元のメッセージ内容が返却されます
MessageStatusStringメッセージステータスメッセージの状態が返却されます
AlertChangeContentStringアラート変更内容アラートの変更内容が返却されます
NodeTitleStringノード名称先頭に”サービスコード_”を含まない、運用対象ノード名が返却されます
MonitoringNameString監視名称監視の名称が返却されます
UserIdString担当者ID担当者のマスターIDを返却します
StartDateString期間開始日形式: YYYYMMDDhhmmss
FinishDateString期間完了日形式: YYYYMMDDhhmmss
TitleStringタイトルチケットに付与されたタイトルが返却されます
CorrespondStartDateString対応開始日時形式: YYYYMMDDhhmmss
CorrespondFinishDateString対応終了日時形式: YYYYMMDDhhmmss
CorresopndOutlineString対応概要対応状況の概要に設定された内容が返却されます
CauseString原因対応状況の原因に設定された内容が返却されます
InfluenceString影響対応状況の影響に設定された内容が返却されます
MeasureString対策対応状況の対策に設定された内容が返却されます
CorrespondProcessUserIdString担当者ID対応メモに紐付く担当者のマスターIDを返却します
UserNameString担当者氏名対応メモに紐付く担当者の氏名を返却します
CorrespondProcessString対応メモ対応メモの内容が返却されます
AssignUserIdString担当者IDインシデントに割り当てられた担当者のマスターIDを返却します
AssignUserNameString担当者氏名インシデントに割り当てられた担当者の氏名を返却します
AssignDateString割当日時形式: YYYYMMDDhhmmss
AssignReleaseDateString割当解除日時形式: YYYYMMDDhhmmss
MasterIncidentIdStringマスターチケット番号関連付けられたチケットの上位のチケット番号です
RelateDateString関連付け日時形式: YYYYMMDDhhmmss
RelateReleaseDateString関連解除日時形式: YYYYMMDDhhmmss
IncidentStateInsertDateStringインシデントステータス登録日時形式: YYYYMMDDhhmmss

IncidentStateUpdateDate

Stringインシデントステータス更新日時形式: YYYYMMDDhhmmss
CorrespondInsertDateStringお客様対応記載登録日時形式: YYYYMMDDhhmmss
CorrespondUpdateDateStringお客様対応記載更新日時形式: YYYYMMDDhhmmss

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

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

パラメータエラー

400

UOM Parameter Error

UOM parameter error occurred. Service code is a required field.サービスコードが不正SERVICE_CODE_REQUIRED_FIELD

パラメータエラー

400

UOM Parameter Error

UOM parameter error occurred. MasterID is a required field.マスターIDが不正MASTER_ID_REQUIRED_FIELD

パラメータエラー

400

UOM Parameter Error

UOM parameter error occurred. There is no MasterID.マスターIDが登録されていないMASTER_ID_NONE

パラメータエラー

400

UOM Parameter Error

UOM parameter error occurred. There is no UOM contract.UOMの契約が存在しないUOM_CONTRACT_NONE
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" : ["IM1234567","IM1234568","IM1234569"],
	"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."
	}
}