RegisterTicket
「UOMポータル」の「チケット管理」と同様に、チケットの登録ができます。
HTTPメソッド | Action | 名称 |
---|---|---|
POST | RegisterTicket | チケット登録 |
1: リクエストパラメータ
インシデントチケットを作成する場合
パラメータ | タイプ | 必須 | 意味 | 最大文字数 | リクエスト例 | 備考 | ||
---|---|---|---|---|---|---|---|---|
ServiceCode | String | ○ | サービスコード | 15 | uom12345678 | ご契約のサービスコードを指定してください | ||
MasterID | String | ○ | マスターID | 15 | SA1234567 | APIの利用者のマスターIDを指定してください | ||
TicketProcessType | String | ○ | チケット種別 | 2 | 1 | インシデントチケットを作成する場合、必ず「1」を指定してください | ||
Title | String | ○ | チケット件名 | 256 | アラート発生XXX | 基本情報のチケット件名を指定してください | ||
StateCode | String | ○ | ステータス | 256 | 未対応 | 基本情報のステータスを指定してください
| ||
SubStateCode | String | − | サブステータス | 256 | 未対応 | 基本情報のサブステータスを指定してください | ||
Priority | String | ○ | 優先度 | 256 | 中 | 基本情報の優先度を指定してください
| ||
SupportedGroup | String | ○ | 担当グループ | 256 | お客様 | 基本情報の担当グループを指定してください
| ||
AssignUserId | String | − | 担当者ID | 15 | SA1234567 | 基本情報の担当者IDを指定してください(マスターIDのみを指定してください) | ||
CorrespondLimitDate | String | − | 対応期限 | 14 | 20220801000000 | YYYYMMDDhhmmssの形式で指定してください | ||
FinishApprovalUserId | String | − | クローズ承認者ID | 15 | SA1234567 | 基本情報のクローズ承認者IDを指定してください(マスターIDのみを指定してください) | ||
Importance | String | − | 重要度 | 256 | 重 | インシデント分類の重要度を指定してください | ||
ManagementGroupId | String | ○ | 管理グループ | 256 | 制限しない | インシデント分類の管理グループを指定してください | ||
Category | String | − | カテゴリ | 256 | HW障害 | インシデント分類のカテゴリを指定してください | ||
SubCategory | String | − | サブカテゴリ | 256 | サブカテゴリ | インシデント分類のサブカテゴリを指定してください | ||
RelatedSystem | String | − | 関連システム/サービス | 65535Byte | Asystem | インシデント分類の関連システム/サービスを指定してください | ||
RelatedCI | String | − | 関連CI | 65535Byte | システム名称:Asystem | インシデント分類の関連CIを指定してください | ||
Impact | String | − | サービス影響 | 256 | 有 | インシデント分類のサービス影響を指定してください | ||
Influence | String | − | 影響範囲 | 2048 | 全顧客 | インシデント分類の影響範囲を指定してください | ||
CauseClassification | String | − | 原因分類 | 256 | 性能不足 | インシデント分類の原因分類を指定してください | ||
Cause | String | − | 原因 | 2048 | XXのメモリが不足していたため | インシデント分類の原因を指定してください | ||
ObstacleDetectionTime | String | ○ | 障害検知日時 | 14 | 20220630132400 | YYYYMMDDhhmmssの形式で指定してください | ||
FaultRecoveryDate | String | − | 障害復旧日時 | 14 | 20220630132500 | YYYYMMDDhhmmssの形式で指定してください | ||
NodeName | String | − | ノード名 | 1024 | testnode_001 | 障害情報のノード名を指定してください | ||
EventId | String | − | 監視ID | 254 | 12345 | 障害情報の監視IDを指定してください | ||
DetectionMessage | String | ○ | 詳細 | 65535Byte | アラートを検知しました。 監視ID:12345 | 障害情報の詳細を指定してください | ||
CorrespondStartDate | String | − | 対応開始日時 | 14 | 20220630133000 | YYYYMMDDhhmmssの形式で指定してください | ||
CorrespondFinishDate | String | − | 対応終了日時 | 14 | 20220630135000 | YYYYMMDDhhmmssの形式で指定してください | ||
CorrespondProcess | String | − | 対応メモ | 2048 | 障害発生に伴い、対応を開始する。 | 対応状況の対応メモを指定してください |
リクエストチケットを作成する場合
パラメータ | タイプ | 必須 | 意味 | 最大文字数 | リクエスト例 | 備考 | ||
---|---|---|---|---|---|---|---|---|
ServiceCode | String | ○ | サービスコード | 15 | uom12345678 | ご契約のサービスコードを指定してください | ||
MasterID | String | ○ | マスターID | 15 | SA1234567 | API利用者のマスターIDを指定してください | ||
TicketProcessType | String | ○ | チケット種別 | 2 | 2 | リクエストチケットを作成する場合、必ず「2」を指定してください | ||
Title | String | ○ | チケット件名 | 256 | XXに関するお問い合わせ | 基本情報のチケット件名を指定してください | ||
StateCode | String | ○ | ステータス | 256 | 新規 | 基本情報のステータスを指定してください
| ||
SubStateCode | String | − | サブステータス | 256 | 未対応 | 基本情報のサブステータスを指定してください | ||
Priority | String | ○ | 優先度 | 256 | 中 | 基本情報の優先度を指定してください
| ||
SupportedGroup | String | ○ | 担当グループ | 256 | お客様 | 基本情報の担当グループを指定してください
| ||
AssignUserId | String | − | 担当者ID | 15 | SA1234567 | 基本情報の担当者IDを指定してください(マスターIDのみを指定してください) | ||
CorrespondLimitDate | String | − | 対応期限 | 14 | 20220630000000 | YYYYMMDDhhmmssの形式で指定してください | ||
FinishApprovalUserId | String | − | クローズ承認者ID | 15 | SA1234567 | 基本情報のクローズ承認者IDを指定してください(マスターIDのみを指定してください) | ||
Urgency | String | − | 緊急度 | 256 | 中 | リクエスト分類の緊急度を指定してください | ||
ManagementGroupId | String | ○ | 管理グループ | 256 | 制限しない | リクエスト分類の管理グループを指定してください | ||
RequestType | String | − | リクエストタイプ | 256 | 問合せ | リクエスト分類のリクエストタイプを指定してください | ||
RequestSubType | String | − | リクエストタイプサブタイプ | 256 | 問合せ(システム) | リクエスト分類のリクエストタイプサブタイプを指定してください | ||
Category | String | − | カテゴリ | 256 | カテゴリ1 | リクエスト分類のカテゴリを指定してください | ||
SubCategory | String | − | サブカテゴリ | 256 | サブカテゴリ1 | リクエスト分類のサブカテゴリを指定してください | ||
RelatedSystem | String | − | 関連システム/サービス | 65535Byte | Asystem | リクエスト分類の関連システム/サービスを指定してください | ||
RepresentativeCustomerId | String | − | 依頼者ID | 15 | SA1234567 | 依頼情報の依頼者名のマスターIDを指定してください(マスターID以外の値は指定しないでください) | ||
RepresentativeCustomerName | String | − | 依頼者名 | 200 | IIJ 太郎 | 依頼情報の依頼者名の氏名または 依頼者の情報を指定してください | ||
CustomerDepartment | String | − | 組織/部署 | 200 | XX会社 XX部 | 依頼情報の組織/部署を指定してください | ||
CustomerContactInfo | String | − | 連絡先 | 200 | 090-1234-5678 | 依頼情報の連絡先を指定してください | ||
RequestDate | String | ○ | 依頼日時 | 14 | 20220630132400 | YYYYMMDDhhmmssの形式で指定してください | ||
AcceptWay | String | − | 受付手段 | 256 | 電話 | 依頼情報の受付手段を指定してください
| ||
RequestContents | String | ○ | 依頼内容 | 65535Byte | IPアドレス:XX.XXX.XX.XXX にて障害を検知しているものの、正常な状態であるため、なぜ検知されているのか教えてほしいとの問合せ。 | 依頼情報の依頼内容を指定してください | ||
RespondWay | String | − | 対応手段 | 256 | メール | 依頼情報の対応手段を指定してください
| ||
RespondContents | String | − | 回答/対応内容 | 2048 | 設定画面でXXと設定すべきところYYと設定されているため。お客様にて設定の修正をしていただくよう、回答 | 依頼情報の回答/対応内容を指定してください | ||
CorrespondStartDate | String | − | 対応開始日時 | 14 | 20220630133000 | YYYYMMDDhhmmssの形式で指定してください | ||
CorrespondFinishDate | String | − | 対応終了日時 | 14 | 20220630135000 | YYYYMMDDhhmmssの形式で指定してください | ||
CorrespondProcess | String | − | 対応メモ | 2048 | 対応を開始する。 | 対応状況の対応メモを指定してください |
2: レスポンス
正常終了
フィールド | タイプ | 意味 | 備考 | ||
---|---|---|---|---|---|
StatusCode | String | ステータスコード | 成功時200が返却されます | ||
Result | − | 結果 | |||
RequestId | String | リクエストID | APIリクエストごとに割り当てられる一意なIDです | ||
TicketId | String | チケット番号 | 作成されたチケット番号が返却されます |
異常終了
フィールド | タイプ | 意味 | 備考 | |
---|---|---|---|---|
Result | − | 結果 | ||
RequestId | String | リクエストID | APIリクエストごとに割り当てられる一意なIDです | |
ErrorType | String | エラータイプ | 異常終了となったエラータイプです | |
ErrorMessage | String | エラーメッセージ | 異常終了となったエラーメッセージです | |
ErrorDetail | String | エラーメッセージ | 異常終了となったエラーの詳細です |
3: エラーメッセージ
エラー | HTTP Status Code | ErrorType | ErrorMessage | 説明 | 備考 |
---|---|---|---|---|---|
パラメータエラー | 200 | PARAMETER_REQUIRED | 必須項目が指定されていません。 | 必須項目のうち、パラメータで指定されていない項目が存在します | 「ErrorDetail」にて、どの必須項目の指定がされていないのか、確認できます |
パラメータエラー | 200 | PARAMETER_TOO_LONG | 最大文字数を超過しています。 | 指定されたパラメータのうち、最大文字数を超過している項目が存在します | 「ErrorDetail」にて、どの項目が最大文字数を超過しているのか、確認できます |
パラメータエラー | 200 | PARAMETER_ERROR | 指定できないパラメータが含まれています。 | 指定されたパラメータに、リクエストパラメータとして使用できない項目が含まれています | 「ErrorDetail」にて、どの項目が使用できない項目なのか、確認できます |
パラメータエラー | 200 | PARAMETER_ERROR | 空欄にできない項目が空文字で指定されています。 | チケットの情報のうち、必須項目など、空欄にはできない項目を、空欄に更新しようとしています | 「ErrorDetail」にて、どの項目が空欄にはできない項目なのか、確認できます |
パラメータエラー | 200 | PARAMETER_ERROR | 入力パラメータが正しく指定されていません。 | 以下のような場合に出力されます
| 「ErrorDetail」にて、どの項目がエラーとなっているのか、確認できます |
パラメータエラー | 200 | PARAMETER_ERROR | ステータスをクローズまたはクローズ承認待ちへ変更する場合、クローズ承認者の指定が必要です。 | ‐ | ‐ |
パラメータエラー | 200 | PARAMETER_ERROR | 指定されたSAアカウントまたはサービスコードが不正です。 | ‐ | ‐ |
認証エラー | 200 | AUTH_FAILURE | 認証エラーです。 | ‐ | ‐ |
権限チェックエラー | 200 | NO_ROLES_TO_CLOSE | ステータスをクローズにする権限がありません。 | リクエストパラメータに指定している、MasterID(SAアカウント)に、承認権限がないため、チケットのステータスを「クローズ」に更新できません | 構成管理機能にて、操作を行うMasterIDに承認権限を付与するか、別のMasterIDでチケットの更新処理を実施してください |
システムエラー | 200 | SYSTEM_ERROR | システムエラーが発生しました。 | UOM-API設備のシステム障害 | ‐ |
- 共通エラーについて詳しくは、「UOM-APIのエラー」をご覧ください。
4:警告メッセージ
なし
5:制限
インシデントチケット及びリクエストチケットのみ登録可能です。
リクエストパラメータの値に、「'」「"」を使用する場合、以下の値に置換を行ってください。
対応する記号 | 置換する文字 |
---|---|
' | ¥' |
" | ¥" |
また、改行を使用したい場合については「¥n」を指定してください。
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 = "20221221" # Content-Type の設定 CONTENTTYPEVALUE = "application/json; charset=utf-8" # チケット登録 # 以下の内容は、適宜修正してください。 METHOD = "POST" ACTION = "RegisterTicket" PARAMS = '{ "ServiceCode":"uom12345678", "MasterID":"SA1234567", "TicketProcessType":"1", "Title":"アラート発生XXX", "StateCode":"未対応", "SubStateCode":"未対応", "Priority":"中", "SupportedGroup":"お客様", "AssignUserId":"SA1234567", "CorrespondLimitDate":"20220801000000", "FinishApprovalUserId":"SA1234567", "Importance":"重", "ManagementGroupId":"制限しない", "Category":"HW障害", "SubCategory":"サブカテゴリ", "RelatedSystem":"Asystem", "RelatedCI":"システム名称:Asystem", "Impact":"有", "Influence":"全顧客", "CauseClassification":"性能不足", "Cause":"XXのメモリが不足していたため", "ObstacleDetectionTime":"20220630132400", "FaultRecoveryDate":"20220630132500", "NodeName":"testnode_001", "EventId":"12345", "DetectionMessage":"アラートを検知しました。", "CorrespondStartDate":"20220630133000", "CorrespondFinishDate":"20220630135000", "CorrespondProcess":"障害発生に伴い、対応を開始する。", }'
レスポンス(XML)
本APIでは、XMLでのリクエストを許可していません。
レスポンス(JSON)
正常終了 { "RegisterTicketResponse": { "RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx", "TicketId":"UTM123456" } } パラメータエラー時 { "ErrorResponse":{ "RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx", "ErrorType":"PARAMETER_ERROR", "ErrorMessage":"指定できないパラメータが含まれています。", "ErrorDetail":{"TestParameter":"PARAMETER_ERROR"} } } 異常終了 { "ErrorResponse":{ "RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx", "ErrorType":"SYSTEM_ERROR", "ErrorMessage":"システムエラーが発生しました。" } }