GetTicketDetail

「UOMポータル」の「チケット管理」と同様に、現在のチケットの詳細情報を取得できます。

HTTPメソッドAction名称
POSTGetTicketDetailチケット詳細情報取得
1: リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
TicketIdStringチケット番号15UTM123456

「UTM」から始まるチケット番号を指定してください

ServiceCodeStringサービスコード15uom12345678ご契約のサービスコードを指定してください
MasterIDStringマスターID15SA1234567API利用者のマスターIDを指定してください
2: レスポンス
リクエストパラメータで指定したチケット番号がインシデントチケットの場合
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時200が返却されます
Result






































結果
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
TitleStringチケット件名

基本情報のチケット件名が返却されます

StateCode

String

ステータス 基本情報のステータスが返却されます
  • 未対応
  • 対応中
  • 復旧済み
  • クローズ承認待ち
  • 差し戻し
  • クローズ
SubStateCodeString

サブステータス

基本情報のサブステータスが返却されます

TicketId

Stringチケット番号基本情報のチケット番号が返却されます
MasterTicketIdStringマスターチケット番号基本情報のマスターチケット番号が返却されます

Priority

String優先度

基本情報の優先度が返却されます

SupportedGroup

String担当グループ

基本情報の担当グループが返却されます

  • お客様
  • SEサポート
  • サポートセンター

AssignUser

String担当者基本情報の担当者が返却されます

CorrespondLimitDate

String対応期限形式:YYYYMMDDhhmmss

CreateDate

Stringチケット作成日時形式:YYYYMMDDhhmmss

CreateUser

Stringチケット作成者基本情報のチケット作成者が返却されます

FinishApprovalDate

Stringクローズ承認日時形式:YYYYMMDDhhmmss

FinishApprovalUser

Stringクローズ承認者基本情報のクローズ承認者が返却されます

CloseDate

Stringチケットクローズ日時形式:YYYYMMDDhhmmss

CloseUser

Stringチケットクローズ者基本情報のチケットクローズ者が返却されます

DisplayTargetControlFlg

String

内部限定のチケット

基本情報の内部限定のチケットが返却されます

  • 顧客公開チケット
  • 内部限定チケット
OtherSystemTaskIdStringタスクID基本情報のタスクIDが返却されます
ImportanceString重要度インシデント分類の重要度が返却されます

ManagementGroupId

String管理グループインシデント分類の管理グループが返却されます

Category

Stringカテゴリインシデント分類のカテゴリが返却されます

SubCategory

Stringサブカテゴリインシデント分類のサブカテゴリが返却されます

RelatedSystem

String関連システム/サービスインシデント分類の関連システム/サービスが返却されます
RelatedCIString関連CIインシデント分類の関連CIが返却されます
ImpactStringサービス影響インシデント分類のサービス影響が返却されます
InfluenceString影響範囲インシデント分類の影響範囲が返却されます
CauseClassificationString原因分類インシデント分類の原因分類が返却されます
CauseString原因インシデント分類の原因が返却されます
ObstacleDetectionTimeString障害検知日時形式:YYYYMMDDhhmmss
FaultRecoveryDateString障害復旧日時形式:YYYYMMDDhhmmss
NodeNameStringノード名障害情報のノード名が返却されます
EventIdString監視ID障害情報の監視IDが返却されます
DetectionMessageString詳細障害情報の詳細が返却されます
CorrespondStartDateString対応開始日時形式:YYYYMMDDhhmmss
CorrespondFinishDateString対応終了日時形式:YYYYMMDDhhmmss
CorrespondProcessList
Array対応メモ対応状況の対応メモの内容が返却されます
CorrespondProcessSeqString対応メモ連番登録日時が古い対応メモから1、2、3…と順に番号を返却します。
CorrespondProcessInsertDateString対応メモ登録日時形式:YYYYMMDDhhmmss
CorrespondProcessUserString対応メモ操作者対応メモを登録したユーザが返却されます
CorrespondProcessString対応メモ
  • 対応メモが返却されます
  • ユーザにて削除が行われた対応メモの場合、「この対応メモは削除されました」の文言が返却されます
CorrespondProcessOperationClassString対応メモ操作区分

ユーザにて、当該対応メモを編集したかが返却されます

  • 0:未編集
  • 1:編集済み
  • 2:削除済み
CorrespondProcessInternalList
Array対応メモ(内部限定)対応状況の対応メモ(内部限定)の内容が返却されます
CorrespondProcessInternalSeqString対応メモ連番(内部限定)登録日時が古い対応メモから1、2、3…と順に番号を返却します
CorrespondProcessInternalInsertDateString対応メモ登録日時(内部限定)形式:YYYYMMDDhhmmss
CorrespondProcessInternalUserString対応メモ操作者(内部限定)対応メモ(内部限定)を登録したユーザが返却されます
CorrespondProcessInternalString対応メモ(内部限定)
  • 対応メモ(内部限定)が返却されます
  • ユーザにて削除が行われた対応メモの場合、「この対応メモは削除されました」の文言が返却されます
CorrespondProcessInternalOperationClassString対応メモ操作区分(内部限定)

ユーザにて、当該対応メモを編集したかが返却されます

  • 0:未編集
  • 1:編集済み
  • 2:削除済み

FileStorageInfoList


Arrayファイルアップロード情報ファイルアップロードの内容が返却されます
FileSeqStringファイル番号チケット管理システム側で設定しているファイルの管理番号が返却されます
FileStorageInsertDateStringファイル登録日時形式:YYYYMMDDhhmmss
FileStorageInsertUserStringファイル登録者ファイルアップロードを実施したユーザが返却されます
FileNameStringファイル名アップロードされているファイル名が返却されます
FileSizeStringファイルサイズ(Byte)アップロードされているファイルのサイズが返却されます

TicketLinkInfoList


Array紐付け情報チケット紐付け情報の内容が返却されます
LinkTicketIdString紐付けチケットIDチケット紐付け情報のチケット番号が返却されます
LinkTicketTypeString紐付けチケット種別チケット紐付け情報のチケット種別が返却されます
LinkTicketStateCodeString紐付けチケットステータスチケット紐付け情報のステータスが返却されます
LinkTicketContentsString紐付けチケット詳細チケット紐付け情報の詳細が返却されます
StateInsertDateStringステータス登録日時形式:YYYYMMDDhhmmss
StateUpdateDateStringステータス更新日時形式:YYYYMMDDhhmmss
SummaryInsertDateStringサマリ登録日時形式:YYYYMMDDhhmmss
SummaryUpdateDateStringサマリ更新日時形式:YYYYMMDDhhmmss
CorrespondInsertDateString対応詳細登録日時形式:YYYYMMDDhhmmss
CorrespondUpdateDateString対応詳細更新日時形式:YYYYMMDDhhmmss
リクエストパラメータで指定したチケット番号がリクエストチケットの場合
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時200が返却されます
Result








結果
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
TitleStringチケット件名基本情報のチケット件名が返却されます
StateCodeStringステータス

基本情報のステータスが返却されます

  • 新規
  • 対応中
  • クローズ承認待ち
  • 差し戻し
  • クローズ
SubStateCodeStringサブステータス基本情報のサブステータスが返却されます
TicketIdStringチケット番号基本情報のチケット番号が返却されます
MasterTicketIdStringマスターチケット番号基本情報のマスターチケット番号が返却されます
PriorityString優先度

基本情報の優先度が返却されます

SupportedGroupString担当グループ

基本情報の担当グループが返却されます

  • お客様
  • SEサポート
  • サポートセンター
AssignUserString担当者基本情報の担当者が返却されます
CorrespondLimitDateString対応期限形式:YYYYMMDDhhmmss
CreateDateStringチケット作成日時形式:YYYYMMDDhhmmss
CreateUserStringチケット作成者基本情報のチケット作成者が返却されます
FinishApprovalDateStringクローズ承認日時形式:YYYYMMDDhhmmss
FinishApprovalUserStringクローズ承認者基本情報のクローズ承認者が返却されます
CloseDateStringチケットクローズ日時形式:YYYYMMDDhhmmss
CloseUserStringチケットクローズ者基本情報のチケットクローズ者が返却されます
UrgencyString緊急度リクエスト分類の緊急度が返却されます
ManagementGroupIdString管理グループリクエスト分類の管理グループが返却されます
RequestTypeStringリクエストタイプリクエスト分類のリクエストタイプが返却されます
RequestSubTypeStringリクエストタイプサブタイプリクエスト分類のリクエストタイプサブタイプが返却されます
CategoryStringカテゴリリクエスト分類のカテゴリが返却されます
SubCategoryStringサブカテゴリリクエスト分類のサブカテゴリが返却されます
RelatedSystemString関連システム/サービスリクエスト分類の関連システム/サービスが返却されます
RepresentativeCustomerString依頼者名依頼情報の依頼者名が返却されます
CustomerDepartmentString組織/部署依頼情報の組織/部署が返却されます
CustomerContactInfoString連絡先依頼情報の連絡先が返却されます
RequestDateString依頼日時依頼情報の依頼日時が返却されます
AcceptWayString受付手段依頼情報の受付手段が返却されます
RequestContentsString依頼内容依頼情報の依頼内容が返却されます
CorrespondStartDateString対応開始日時対応状況の対応開始日時が返却されます
CorrespondFinishDateString対応終了日時対応状況の対応終了日時が返却されます
RespondWayString対応手段対応状況の対応手段が返却されます
RespondContentsString回答/対応内容対応状況の回答/対応内容が返却されます

CorrespondProcessList


Array対応メモ対応状況の対応メモの内容が返却されます
CorrespondProcessSeqString対応メモ連番登録日時が古い対応メモから1、2、3…と順に番号を返却します
CorrespondProcessInsertDateString対応メモ登録日時形式:YYYYMMDDhhmmss
CorrespondProcessUserString対応メモ操作者対応メモを登録したユーザが返却されます
CorrespondProcessString対応メモ
  • 対応メモが返却されます
  • ユーザにて削除が行われた対応メモの場合、「この対応メモは削除されました」の文言が返却されます
CorrespondProcessOperationClassString対応メモ操作区分

ユーザにて、当該対応メモを編集したかが返却されます

  • 0:未編集
  • 1:編集済み
  • 2:削除済み

FileStorageInfoList


Arrayファイルアップロード情報ファイルアップロードの内容が返却されます
FileSeqStringファイル番号チケット管理システム側で設定しているファイルの管理番号が返却されます
FileStorageInsertDateStringファイル登録日時形式:YYYYMMDDhhmmss
FileStorageInsertUserStringファイル登録者ファイルアップロードを実施したユーザが返却されます
FileNameStringファイル名アップロードされているファイル名が返却されます
FileSizeStringファイルサイズ(Byte)アップロードされているファイルのサイズが返却されます
TicketLinkInfoList
Array紐付け情報チケット紐付け情報の内容が返却されます
LinkTicketIdString紐付けチケットIDチケット紐付け情報のチケット番号が返却されます
LinkTicketTypeString紐付けチケット種別チケット紐付け情報のチケット種別が返却されます
LinkTicketStateCodeString紐付けチケットステータスチケット紐付け情報のステータスが返却されます
LinkTicketContentsString紐付けチケット内容チケット紐付け情報の詳細が返却されます
StateInsertDateStringステータス登録日時形式:YYYYMMDDhhmmss
StateUpdateDateStringステータス更新日時形式:YYYYMMDDhhmmss
SummaryInsertDateStringサマリ登録日時形式:YYYYMMDDhhmmss
SummaryUpdateDateStringサマリ更新日時形式:YYYYMMDDhhmmss
CorrespondInsertDateString対応詳細登録日時形式:YYYYMMDDhhmmss
CorrespondUpdateDateString対応詳細更新日時形式:YYYYMMDDhhmmss
DetailInsertDateString詳細登録日時形式:YYYYMMDDhhmmss
DetailUpdateDateString詳細更新日時形式:YYYYMMDDhhmmss
異常終了
フィールドタイプ意味備考
Result

結果
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ErrorTypeStringエラータイプ異常終了となったエラータイプです
ErrorMessageStringエラーメッセージ異常終了となったエラーメッセージです
ErrorDetailStringエラーメッセージ異常終了となったエラーの詳細です
3: エラーメッセージ
エラーHTTP Status CodeErrorTypeErrorMessage説明備考
パラメータエラー200PARAMETER_REQUIRED必須項目が指定されていません。必須項目のうち、パラメータで指定されていない項目が存在します 「ErrorDetail」にて、どの必須項目の指定がされていないのか、確認できます
パラメータエラー200PARAMETER_TOO_LONG最大文字数を超過しています。指定されたパラメータのうち、最大文字数を超過している項目が存在します 「ErrorDetail」にて、どの項目が最大文字数を超過しているのか、確認できます
パラメータエラー200PARAMETER_ERROR指定できないパラメータが含まれています。指定されたパラメータに、リクエストパラメータとして使用できない項目が含まれています「ErrorDetail」にて、どの項目が使用できない項目なのか、確認できます
パラメータエラー200PARAMETER_ERROR入力パラメータが正しく指定されていません。

以下のような場合に出力されます

  • 選択肢として使用できない値を指定 (例:「優先度」(使用できる選択肢は高/中/低)に「他」を指定)
  • 日付の値の形式が「yyyyMMddHHmmss」形式ではない

など

「ErrorDetail」にて、どの項目がエラーとなっているのか、確認できます
パラメータエラー200PARAMETER_ERROR指定されたSAアカウントまたはサービスコードが不正です。



パラメータエラー200NO_TICKET_ID指定されたチケットIDのデータは存在しない、または閲覧権限がありません。

認証エラー200AUTH_FAILURE認証エラーです。

システムエラー200SYSTEM_ERRORシステムエラーが発生しました。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",
		"StateUpdateDate":"20221005163649",
		"Category":"HW障害",
		"NodeName":"testnode_001",
		"AssignUser":"SA1234567 IIJ太郎",
		"RelatedCI":"ソフトウェア名称:XXXXX",
		"CorrespondLimitDate":"20221031000000",
		"CreateDate":"20221005143549",
		"CloseDate":"",
		"CorrespondInsertDate":"20221005143630",
		"SubStateCode":"対応中",
		"Importance":"致命的",
		"FaultRecoveryDate":"20221005142811",
		"FinishApprovalDate":"",
		"SupportedGroup":"SEサポート",
		"CorrespondFinishDate":"20221005143015",
		"CorrespondProcessList":[{"CorrespondProcess":"対応メモ",
		"CorrespondProcessInsertDate":"20221005143630",
		"CorrespondProcessUser":"SA1234567 IIJ太郎",
		"CorrespondProcessSeq":"1",
		"CorrespondProcessOperationClass":"0"}],
		"Cause":"原因",
		"EventId":"12345",
		"FileStorageInfoList":[{"FileSeq":"10598",
		"FileStorageInsertDate":"20221005143649",
		"FileName":"test.txt",
		"FileStorageInsertUser":"SA1234567 IIJ太郎",
		"FileSize":"104333312"}],
		"Impact":"有",
		"SummaryUpdateDate":"",
		"Priority":"中",
		"CauseClassification":"性能不足",
		"DetectionMessage":"アラートが発生しました。",
		"StateCode":"対応中",
		"Title":"アラート通知 uom12345678_testnode_001 (ID: UTM123456) uom12345678",
		"CreateUser":"SA1234567 IIJ太郎",
		"ManagementGroupId":"制限しない",
 		"ObstacleDetectionTime":"20221005142034",
		"CorrespondStartDate":"20221005142646",
		"TicketId":"UTM123456",
		"CloseUser":"",
		"SubCategory":"サブカテゴリ",
		"CorrespondUpdateDate":"",
 		"MasterTicketId":"UTM999999",
		"Influence":"影響範囲",
		"StateInsertDate":"20221005143629",
		"RelatedSystem":"test_system",
		"SummaryInsertDate":"20221005143630",
		"FinishApprovalUser":"",
		"TicketLinkInfoList":[{"LinkTicketContents":"紐づけチケット詳細",
		"LinkTicketStateCode":"新規",
		"LinkTicketId":"UTM666666",
		"LinkTicketType":"リクエスト"}],
	}
}

パラメータエラー時
{
	"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":"システムエラーが発生しました。"
	}
}