GetIncidentSummary
「UOMポータル」の「チケット管理」と同様に、現在のインシデント情報のサマリを取得できます。
| HTTPメソッド | Action | 名称 |
|---|---|---|
| POST | GetIncidentSummary | インシデントサマリ取得 |
1： リクエストパラメータ
| パラメータ | タイプ | 必須 | 意味 | 最大文字数 | リクエスト例 | 備考 | ||
|---|---|---|---|---|---|---|---|---|
| OfficeId | String | ○ | 事業者コード | 11 | IIJ00000001 | 固定 | ||
| ServiceCode | String | ○ | サービスコード | 15 | uom12345678 | ご契約のサービスコードを指定してください | ||
| MasterId | String | ○ | 申請者マスターID | 15 | SA9876543 | マスターIDを指定してください | ||
| StateCode | String[] | − | ステータスコード | 3 | 000 | 以下から指定してください
| ||
| ParFlg | String[] | − | 親フラグ | 1 | 1 | 以下から指定してください
| ||
| ObstacleDetectionTimeFrom | String | − | 障害検知日時from | 14 | 20170707101030 | YYYYMMDDhhmmssの形式で指定してください | ||
| ObstacleDetectionTimeTo | String | − | 障害検知日時To | 14 | 20170720101030 | 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 | ステータスコード | 以下が返却されます
| ||
| TicketList | Array | チケットリスト | チケット情報を格納したリストです | ||
| IncidentId | String | チケット番号 | チケット番号です | ||
| StateCode | String | ステータスコード | 以下が返却されます
| ||
| ReceivingTime | String | 検知日時 | 形式：YYYYMMDDhhmmss | ||
| TicketType | String | チケット種別 | 以下が返却されます
| ||
| ParFlg | String | 親フラグ | 以下が返却されます
| ||
| DelFlg | String | 削除フラグ | 以下が返却されます
| ||
| NodeName | String | ノード名 | 運用対象ノード名が返却されます | ||
| DetectionMessage | String | 検知メッセージ | 障害情報の受付メッセージが返却されます | ||
| ObstacleDetectionTime | String | 障害検知日時 | 形式：YYYYMMDDhhmmss | ||
| EventId | String | イベントID | 障害情報の監視IDが返却されます | ||
| MessageManagerId | String | メッセージ管理ID | インシデントのメッセージの管理IDが返却されます | ||
| StartDate | String | 期間開始日 | 形式:YYYYMMDDhhmmss | ||
| FinishDate | String | 期間完了日 | 形式:YYYYMMDDhhmmss | ||
| Title | String | タイトル | チケットに付与されたタイトルが返却されます | ||
| AssignUserId | String | 担当者ID | チケットに担当者が割り当てられている場合、担当者のマスターIDが返却されます | ||
| AssignUserName | String | 担当者氏名 | チケットに担当者が割り当てられている場合、担当者の氏名が返却されます | ||
| AssignUserDate | String | 割当日時 | 形式：YYYYMMDDhhmmss | ||
| MasterIncidentId | String | マスターチケット番号 | 関連付けられたチケットの上位のチケット番号です | ||
| RelateDate | 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 = "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":"UTM123456",
"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."
}
}