GetIncidentRelate

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

HTTPメソッドAction名称
POSTGetIncidentRelateインシデント関連取得
1: リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
OfficeIdString事業者コード11IIJ00000001固定
ServiceCodeStringサービスコード15uom12345678ご契約のサービスコードを指定してください
MasterIdString申請者マスターID15SA9876543SAで始まるIDを指定してください
IncidentIdStringチケット番号15IM1234567チケット番号を指定してください
LocaleString表示言語10

下記のみ利用可能です

0:日本語

2: レスポンス
正常終了
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時200が返却されます
Result 結果 
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
MasterIncidentIdStringマスターチケット番号関連付けられたチケットの上位のチケット番号です
IncidentIdList Arrayチケットリストチケット情報を格納したリストです
IncidentIdStringチケット番号関連付けられたチケットの下位のチケット番号です
StateCodeStringステータスコード

以下が返却されます

000:未対応

100:対応中

200:クローズ

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

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

パラメータエラー

400

Parameter Error

There 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 = "GetIncidentRelate"
PARAMS = '{
	"OfficeId" : "IIJ00000001",
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"IncidentId" : "IM1234568",
	"Locale" : "0"
}'
レスポンス(XML)

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

レスポンス(JSON)
正常終了
{
	"GetIncidentRelateResponse":{
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"MasterIncidentId":"IM1234567",
		"IncidentIdList":[
			{"IncidentId":" IM1234568","StateCode":"000"},
			{"IncidentId":" IM1234568","StateCode":"000"}
		]
	}
}
異常終了
{
	"ErrorResponse":{
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"ErrorType":"UOMWebSystemError",
		"ErrorMessage":"UOM Web System error occurred."
	}
}