GetTicketDetail
「UOMポータル」の「チケット管理」と同様に、現在のチケットの詳細情報を取得できます。
| HTTPメソッド | Action | 名称 |
|---|---|---|
| POST | GetTicketDetail | チケット詳細情報取得 |
1: リクエストパラメータ
| パラメータ | タイプ | 必須 | 意味 | 最大文字数 | リクエスト例 | 備考 | ||
|---|---|---|---|---|---|---|---|---|
| TicketId | String | ○ | チケット番号 | 15 | UTM123456 | 「UTM」から始まるチケット番号を指定してください | ||
| ServiceCode | String | ○ | サービスコード | 15 | uom12345678 | ご契約のサービスコードを指定してください | ||
| MasterID | String | ○ | マスターID | 15 | SA1234567 | API利用者のマスターIDを指定してください | ||
2: レスポンス
リクエストパラメータで指定したチケット番号がインシデントチケットの場合
| フィールド | タイプ | 意味 | 備考 | ||
|---|---|---|---|---|---|
| StatusCode | String | ステータスコード | 成功時200が返却されます | ||
| Result | ⁻ | 結果 | |||
| RequestId | String | リクエストID | APIリクエストごとに割り当てられる一意なIDです | ||
| Title | String | チケット件名 | 基本情報のチケット件名が返却されます | ||
| StateCode | String | ステータス | 基本情報のステータスが返却されます
| ||
| SubStateCode | String | サブステータス | 基本情報のサブステータスが返却されます | ||
TicketId | String | チケット番号 | 基本情報のチケット番号が返却されます | ||
| MasterTicketId | String | マスターチケット番号 | 基本情報のマスターチケット番号が返却されます | ||
Priority | String | 優先度 | 基本情報の優先度が返却されます
| ||
SupportedGroup | String | 担当グループ | 基本情報の担当グループが返却されます
| ||
AssignUser | String | 担当者 | 基本情報の担当者が返却されます | ||
CorrespondLimitDate | String | 対応期限 | 形式:YYYYMMDDhhmmss | ||
CreateDate | String | チケット作成日時 | 形式:YYYYMMDDhhmmss | ||
CreateUser | String | チケット作成者 | 基本情報のチケット作成者が返却されます | ||
FinishApprovalDate | String | クローズ承認日時 | 形式:YYYYMMDDhhmmss | ||
FinishApprovalUser | String | クローズ承認者 | 基本情報のクローズ承認者が返却されます | ||
CloseDate | String | チケットクローズ日時 | 形式:YYYYMMDDhhmmss | ||
CloseUser | String | チケットクローズ者 | 基本情報のチケットクローズ者が返却されます | ||
| LastModificationDate | String | チケット最終更新日時 | 形式:YYYYMMDDhhmmss | ||
| LastModificationUser | String | チケット最終更新者 | 基本情報のチケット最終更新者が返却されます | ||
DisplayTargetControlFlg | String | 内部限定のチケット | 基本情報の内部限定のチケットが返却されます
| ||
| OtherSystemTaskId | String | タスクID | 基本情報のタスクIDが返却されます | ||
| Importance | String | 重要度 | インシデント分類の重要度が返却されます | ||
ManagementGroupId | String | 管理グループ | インシデント分類の管理グループが返却されます | ||
Category | String | カテゴリ | インシデント分類のカテゴリが返却されます | ||
SubCategory | String | サブカテゴリ | インシデント分類のサブカテゴリが返却されます | ||
RelatedSystem | String | 関連システム/サービス | インシデント分類の関連システム/サービスが返却されます | ||
| RelatedCI | String | 関連CI | インシデント分類の関連CIが返却されます | ||
| Impact | String | サービス影響 | インシデント分類のサービス影響が返却されます | ||
| Influence | String | 影響範囲 | インシデント分類の影響範囲が返却されます | ||
| CauseClassification | String | 原因分類 | インシデント分類の原因分類が返却されます | ||
| Cause | String | 原因 | インシデント分類の原因が返却されます | ||
| ObstacleDetectionTime | String | 障害検知日時 | 形式:YYYYMMDDhhmmss | ||
| FaultRecoveryDate | String | 障害復旧日時 | 形式:YYYYMMDDhhmmss | ||
| NodeName | String | ノード名 | 障害情報のノード名が返却されます | ||
| EventId | String | 監視ID | 障害情報の監視IDが返却されます | ||
| DetectionMessage | String | 詳細 | 障害情報の詳細が返却されます | ||
| CorrespondStartDate | String | 対応開始日時 | 形式:YYYYMMDDhhmmss | ||
| CorrespondFinishDate | String | 対応終了日時 | 形式:YYYYMMDDhhmmss | ||
| CorrespondProcessList | Array | 対応メモ | 対応状況の対応メモの内容が返却されます | ||
| CorrespondProcessSeq | String | 対応メモ連番 | 登録日時が古い対応メモから1、2、3…と順に番号を返却します。 | ||
| CorrespondProcessInsertDate | String | 対応メモ登録日時 | 形式:YYYYMMDDhhmmss | ||
| CorrespondProcessUser | String | 対応メモ操作者 | 対応メモを登録したユーザが返却されます | ||
| CorrespondProcess | String | 対応メモ |
| ||
| CorrespondProcessOperationClass | String | 対応メモ操作区分 | ユーザにて、当該対応メモを編集したかが返却されます
| ||
| CorrespondProcessInternalList | Array | 対応メモ(内部限定) | 対応状況の対応メモ(内部限定)の内容が返却されます | ||
| CorrespondProcessInternalSeq | String | 対応メモ連番(内部限定) | 登録日時が古い対応メモから1、2、3…と順に番号を返却します | ||
| CorrespondProcessInternalInsertDate | String | 対応メモ登録日時(内部限定) | 形式:YYYYMMDDhhmmss | ||
| CorrespondProcessInternalUser | String | 対応メモ操作者(内部限定) | 対応メモ(内部限定)を登録したユーザが返却されます | ||
| CorrespondProcessInternal | String | 対応メモ(内部限定) |
| ||
| CorrespondProcessInternalOperationClass | String | 対応メモ操作区分(内部限定) | ユーザにて、当該対応メモを編集したかが返却されます
| ||
FileStorageInfoList | Array | ファイルアップロード情報 | ファイルアップロードの内容が返却されます | ||
| FileSeq | String | ファイル番号 | チケット管理システム側で設定しているファイルの管理番号が返却されます | ||
| FileStorageInsertDate | String | ファイル登録日時 | 形式:YYYYMMDDhhmmss | ||
| FileStorageInsertUser | String | ファイル登録者 | ファイルアップロードを実施したユーザが返却されます | ||
| FileName | String | ファイル名 | アップロードされているファイル名が返却されます | ||
| FileSize | String | ファイルサイズ(Byte) | アップロードされているファイルのサイズが返却されます | ||
TicketLinkInfoList | Array | 紐付け情報 | チケット紐付け情報の内容が返却されます | ||
| LinkTicketId | String | 紐付けチケットID | チケット紐付け情報のチケット番号が返却されます | ||
| LinkTicketType | String | 紐付けチケット種別 | チケット紐付け情報のチケット種別が返却されます | ||
| LinkTicketStateCode | String | 紐付けチケットステータス | チケット紐付け情報のステータスが返却されます | ||
| LinkTicketContents | String | 紐付けチケット詳細 | チケット紐付け情報の詳細が返却されます | ||
| StateInsertDate | String | ステータス登録日時 | 形式:YYYYMMDDhhmmss | ||
| StateUpdateDate | String | ステータス更新日時 | 形式:YYYYMMDDhhmmss | ||
| SummaryInsertDate | String | サマリ登録日時 | 形式:YYYYMMDDhhmmss | ||
| SummaryUpdateDate | String | サマリ更新日時 | 形式:YYYYMMDDhhmmss | ||
| CorrespondInsertDate | String | 対応詳細登録日時 | 形式:YYYYMMDDhhmmss | ||
| CorrespondUpdateDate | String | 対応詳細更新日時 | 形式:YYYYMMDDhhmmss | ||
リクエストパラメータで指定したチケット番号がリクエストチケットの場合
| フィールド | タイプ | 意味 | 備考 | ||
|---|---|---|---|---|---|
| StatusCode | String | ステータスコード | 成功時200が返却されます | ||
| Result | ⁻ | 結果 | |||
| RequestId | String | リクエストID | APIリクエストごとに割り当てられる一意なIDです | ||
| Title | String | チケット件名 | 基本情報のチケット件名が返却されます | ||
| StateCode | String | ステータス | 基本情報のステータスが返却されます
| ||
| SubStateCode | String | サブステータス | 基本情報のサブステータスが返却されます | ||
| TicketId | String | チケット番号 | 基本情報のチケット番号が返却されます | ||
| MasterTicketId | String | マスターチケット番号 | 基本情報のマスターチケット番号が返却されます | ||
| Priority | String | 優先度 | 基本情報の優先度が返却されます
| ||
| SupportedGroup | String | 担当グループ | 基本情報の担当グループが返却されます
| ||
| AssignUser | String | 担当者 | 基本情報の担当者が返却されます | ||
| CorrespondLimitDate | String | 対応期限 | 形式:YYYYMMDDhhmmss | ||
| CreateDate | String | チケット作成日時 | 形式:YYYYMMDDhhmmss | ||
| CreateUser | String | チケット作成者 | 基本情報のチケット作成者が返却されます | ||
| FinishApprovalDate | String | クローズ承認日時 | 形式:YYYYMMDDhhmmss | ||
| FinishApprovalUser | String | クローズ承認者 | 基本情報のクローズ承認者が返却されます | ||
| CloseDate | String | チケットクローズ日時 | 形式:YYYYMMDDhhmmss | ||
| CloseUser | String | チケットクローズ者 | 基本情報のチケットクローズ者が返却されます | ||
| LastModificationDate | String | チケット最終更新日時 | 形式:YYYYMMDDhhmmss | ||
| LastModificationUser | String | チケット最終更新者 | 基本情報のチケット最終更新者が返却されます | ||
| Urgency | String | 緊急度 | リクエスト分類の緊急度が返却されます | ||
| ManagementGroupId | String | 管理グループ | リクエスト分類の管理グループが返却されます | ||
| RequestType | String | リクエストタイプ | リクエスト分類のリクエストタイプが返却されます | ||
| RequestSubType | String | リクエストタイプサブタイプ | リクエスト分類のリクエストタイプサブタイプが返却されます | ||
| Category | String | カテゴリ | リクエスト分類のカテゴリが返却されます | ||
| SubCategory | String | サブカテゴリ | リクエスト分類のサブカテゴリが返却されます | ||
| RelatedSystem | String | 関連システム/サービス | リクエスト分類の関連システム/サービスが返却されます | ||
| RepresentativeCustomer | String | 依頼者名 | 依頼情報の依頼者名が返却されます | ||
| CustomerDepartment | String | 組織/部署 | 依頼情報の組織/部署が返却されます | ||
| CustomerContactInfo | String | 連絡先 | 依頼情報の連絡先が返却されます | ||
| RequestDate | String | 依頼日時 | 依頼情報の依頼日時が返却されます | ||
| AcceptWay | String | 受付手段 | 依頼情報の受付手段が返却されます | ||
| RequestContents | String | 依頼内容 | 依頼情報の依頼内容が返却されます | ||
| CorrespondStartDate | String | 対応開始日時 | 対応状況の対応開始日時が返却されます | ||
| CorrespondFinishDate | String | 対応終了日時 | 対応状況の対応終了日時が返却されます | ||
| RespondWay | String | 対応手段 | 対応状況の対応手段が返却されます | ||
| RespondContents | String | 回答/対応内容 | 対応状況の回答/対応内容が返却されます | ||
CorrespondProcessList | Array | 対応メモ | 対応状況の対応メモの内容が返却されます | ||
| CorrespondProcessSeq | String | 対応メモ連番 | 登録日時が古い対応メモから1、2、3…と順に番号を返却します | ||
| CorrespondProcessInsertDate | String | 対応メモ登録日時 | 形式:YYYYMMDDhhmmss | ||
| CorrespondProcessUser | String | 対応メモ操作者 | 対応メモを登録したユーザが返却されます | ||
| CorrespondProcess | String | 対応メモ |
| ||
| CorrespondProcessOperationClass | String | 対応メモ操作区分 | ユーザにて、当該対応メモを編集したかが返却されます
| ||
FileStorageInfoList | Array | ファイルアップロード情報 | ファイルアップロードの内容が返却されます | ||
| FileSeq | String | ファイル番号 | チケット管理システム側で設定しているファイルの管理番号が返却されます | ||
| FileStorageInsertDate | String | ファイル登録日時 | 形式:YYYYMMDDhhmmss | ||
| FileStorageInsertUser | String | ファイル登録者 | ファイルアップロードを実施したユーザが返却されます | ||
| FileName | String | ファイル名 | アップロードされているファイル名が返却されます | ||
| FileSize | String | ファイルサイズ(Byte) | アップロードされているファイルのサイズが返却されます | ||
| TicketLinkInfoList | Array | 紐付け情報 | チケット紐付け情報の内容が返却されます | ||
| LinkTicketId | String | 紐付けチケットID | チケット紐付け情報のチケット番号が返却されます | ||
| LinkTicketType | String | 紐付けチケット種別 | チケット紐付け情報のチケット種別が返却されます | ||
| LinkTicketStateCode | String | 紐付けチケットステータス | チケット紐付け情報のステータスが返却されます | ||
| LinkTicketContents | String | 紐付けチケット内容 | チケット紐付け情報の詳細が返却されます | ||
| StateInsertDate | String | ステータス登録日時 | 形式:YYYYMMDDhhmmss | ||
| StateUpdateDate | String | ステータス更新日時 | 形式:YYYYMMDDhhmmss | ||
| SummaryInsertDate | String | サマリ登録日時 | 形式:YYYYMMDDhhmmss | ||
| SummaryUpdateDate | String | サマリ更新日時 | 形式:YYYYMMDDhhmmss | ||
| CorrespondInsertDate | String | 対応詳細登録日時 | 形式:YYYYMMDDhhmmss | ||
| CorrespondUpdateDate | String | 対応詳細更新日時 | 形式:YYYYMMDDhhmmss | ||
| DetailInsertDate | String | 詳細登録日時 | 形式:YYYYMMDDhhmmss | ||
| DetailUpdateDate | String | 詳細更新日時 | 形式:YYYYMMDDhhmmss | ||
異常終了
| フィールド | タイプ | 意味 | 備考 | |
|---|---|---|---|---|
| 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 | 指定されたSAアカウントまたはサービスコードが不正です。 | ‐ | ‐ |
| パラメータエラー | 200 | NO_TICKET_ID | 指定されたチケットIDのデータは存在しない、または閲覧権限がありません。 | ‐ | ‐ |
| 認証エラー | 200 | AUTH_FAILURE | 認証エラーです。 | ‐ | ‐ |
| システムエラー | 200 | SYSTEM_ERROR | システムエラーが発生しました。 | 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 = "20221221"
# Content-Type の設定
CONTENTTYPEVALUE = "application/json; charset=utf-8"
# チケット詳細情報取得
# 以下の内容は、適宜修正してください。
METHOD = "POST"
ACTION = "GetTicketDetail"
PARAMS = '{
"ServiceCode":"uom12345678",
"TicketId":"UTM123456",
"MasterID":"SA1234567"
}'
レスポンス(XML)
本APIでは、XMLでのリクエストを許可していません。
レスポンス(JSON)
正常終了
{
"GetTicketDetailResponse": {
"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"Title":"アラート通知 uom12345678_testnode_001 (ID: UTM123456) uom12345678",
"StateCode":"対応中",
"TicketId":"UTM123456",
"MasterTicketId":"UTM999999",
"Priority":"中",
"AssignUser":"SA1234567 IIJ太郎",
"CorrespondLimitDate":"20221031000000",
"CreateDate":"20221005143549",
"CreateUser":"SA1234567 IIJ太郎",
"FinishApprovalDate":"",
"FinishApprovalUser":"",
"CloseDate":"",
"CloseUser":"",
"LastModificationDate":"20221005163649",
"LastModificationUser":"SA1234567 IIJ太郎",
"ManagementGroupId":"制限しない",
"FileStorageInfoList":[{"FileSeq":"10598",
"FileStorageInsertDate":"20221005143649",
"FileName":"test.txt",
"FileStorageInsertUser":"SA1234567 IIJ太郎",
"FileSize":"104333312"}],
"TicketLinkInfoList":[{"LinkTicketContents":"紐づけチケット詳細",
"LinkTicketStateCode":"新規",
"LinkTicketId":"UTM666666",
"LinkTicketType":"リクエスト"}],
"StateInsertDate":"20221005143629",
"StateUpdateDate":"20221005163649",
"SummaryInsertDate":"20221005143630",
"SummaryUpdateDate":"",
"SubStateCode":"対応中",
"SupportedGroup":"SEサポート",
"Importance":"致命的",
"Category":"HW障害",
"SubCategory":"サブカテゴリ",
"RelatedSystem":"test_system",
"RelatedCI":"ソフトウェア名称:XXXXX",
"Impact":"有",
"Influence":"影響範囲",
"CauseClassification":"性能不足",
"Cause":"原因",
"ObstacleDetectionTime":"20221005142034",
"FaultRecoveryDate":"20221005142811",
"NodeName":"testnode_001",
"EventId":"12345",
"DetectionMessage":"アラートが発生しました。",
"CorrespondStartDate":"20221005142646",
"CorrespondFinishDate":"20221005143015",
"CorrespondProcessList":[{"CorrespondProcess":"対応メモ",
"CorrespondProcessInsertDate":"20221005143630",
"CorrespondProcessUser":"SA1234567 IIJ太郎",
"CorrespondProcessSeq":"1",
"CorrespondProcessOperationClass":"0"}],
"CorrespondInsertDate":"20221005143630",
"CorrespondUpdateDate":"",
}
}
パラメータエラー時
{
"ErrorResponse":{
"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"ErrorType":"PARAMETER_ERROR",
"ErrorMessage":"指定できないパラメータが含まれています。",
"ErrorDetail":{"TicketProcessType":"PARAMETER_ERROR"}
}
}
異常終了
{
"ErrorResponse":{
"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"ErrorType":"SYSTEM_ERROR",
"ErrorMessage":"システムエラーが発生しました。"
}
}