公開
マニュアル一覧へ

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

IIJ統合運用管理サービス API Reference

GetIncidentCorrespondProcess

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

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

下記のみ利用可能です

0：日本語

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






Arrayお客様対応メモリスト対応メモ情報を格納したリストです
CorrespondProcessSeqString対応メモSEQ対応メモのシーケンス番号です
UserIdString担当者ID対応メモに紐付く担当者のマスターIDを返却します
UserNameString担当者氏名対応メモに紐付く担当者の氏名を返却します
CorrespondProcessString対応メモチケットの対応メモが返却されます
CorrespondProcessInsertDateStringお客様対応メモ登録日時形式: YYYYMMDDhhmmss
CorrespondProcessUpdateDateStringお客様対応メモ更新日時形式: YYYYMMDDhhmmss

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

3： エラーメッセージ
エラーHTTP Status CodeErrorTypeErrorMessage説明
パラメータエラー200UOMParameterErrorUOM parameter error occurred.

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

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

など

例外エラー200UOMExceptionErrorUOM system exception error occurred.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 = "GetIncidentCorrespondProcess"
PARAMS = '{
	"OfficeId" : "IIJ00000001",
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"IncidentId" : "UTM123456",
	"Locale" : "0"
}'
レスポンス（XML）

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

レスポンス（JSON）
正常終了
{
	"GetIncidentCorrespondProcessResponse": {
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"CorrespondProcessList":[
			{"CorrespondProcessSeq":"",
			"UserId":"",
			"UserName":"",
			"CorrespondProcess":"",
			"CorrespondProcessInsertDate":"",
			"CorrespondProcessUpdateDate":""}
		]
	}
}
異常終了
{
	"ErrorResponse":{
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"ErrorType":"UOMWebSystemError",
		"ErrorMessage":"UOM Web System error occurred."
	}
}