GetIncidentCorrespondProcess
「UOMポータル」の「チケット管理」と同様に、現在のインシデント情報の対応メモを取得できます。
HTTPメソッド | Action | 名称 |
---|---|---|
POST | GetIncidentCorrespondProcess | インシデント対応メモ取得 |
1: リクエストパラメータ
パラメータ | タイプ | 必須 | 意味 | 最大文字数 | リクエスト例 | 備考 | ||
---|---|---|---|---|---|---|---|---|
OfficeId | String | ○ | 事業者コード | 11 | IIJ00000001 | 固定 | ||
ServiceCode | String | ○ | サービスコード | 15 | uom12345678 | ご契約のサービスコードを指定してください | ||
MasterId | String | ○ | 申請者マスターID | 15 | SA9876543 | マスターIDを指定してください | ||
IncidentId | String | ○ | チケット番号 | 15 | UTM123456 | チケット番号を指定してください | ||
Locale | String | ○ | 表示言語 | 1 | 0 | 下記のみ利用可能です 0:日本語 |
2: レスポンス
正常終了
フィールド | タイプ | 意味 | 備考 | |||
---|---|---|---|---|---|---|
StatusCode | String | ステータスコード | 成功時200が返却されます | |||
Result | − | 結果 | ||||
RequestId | String | リクエストID | APIリクエストごとに割り当てられる一意なIDです | |||
CorrespondProcessList | Array | お客様対応メモリスト | 対応メモ情報を格納したリストです | |||
CorrespondProcessSeq | String | 対応メモSEQ | 対応メモのシーケンス番号です | |||
UserId | String | 担当者ID | 対応メモに紐付く担当者のマスターIDを返却します | |||
UserName | String | 担当者氏名 | 対応メモに紐付く担当者の氏名を返却します | |||
CorrespondProcess | String | 対応メモ | チケットの対応メモが返却されます | |||
CorrespondProcessInsertDate | String | お客様対応メモ登録日時 | 形式: YYYYMMDDhhmmss | |||
CorrespondProcessUpdateDate | 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 = "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." } }