公開
マニュアル一覧へ

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

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

UpdateTicket

「UOMポータル」の「チケット管理」と同様に、チケットの更新ができます。

HTTPメソッドAction名称
POSTUpdateTicketチケット更新
1： リクエストパラメータ
インシデントチケットを更新する場合
パラメータタイプ必須意味最大文字数リクエスト例備考
ServiceCodeString○サービスコード15uom12345678ご契約のサービスコードを指定してください
MasterIDString○マスターID15SA1234567API利用者のマスターIDを指定してください
TicketProcessTypeString○チケット種別21インシデントチケットを更新する場合、必ず「1」を指定してください
TitleString−　チケット件名256アラート発生XXX基本情報のチケット件名を指定してください
StateCodeString−ステータス256未対応

基本情報のステータスを指定してください

  • 未対応
  • 対応中
  • 復旧済み
  • クローズ承認待ち
  • 差し戻し
  • クローズ
SubStateCodeString−　サブステータス256未対応基本情報のサブステータスを指定してください
PriorityString○優先度256中

基本情報の優先度を指定してください

  • 高
  • 中
  • 低
SupportedGroupString−担当グループ256お客様

基本情報の担当グループを指定してください

  • お客様
  • SEサポート
  • サポートセンター
AssignUserIdString−担当者ID15SA1234567基本情報の担当者IDを指定してください（マスターIDのみを指定してください）
CorrespondLimitDateString−対応期限1420220801000000YYYYMMDDhhmmssの形式で指定してください
FinishApprovalUserIdString−クローズ承認者ID15SA1234567基本情報のクローズ承認者IDを指定してください（マスターIDのみを指定してください）
ImportanceString−重要度256重インシデント分類の重要度を指定してください
ManagementGroupIdString−管理グループ256制限しないインシデント分類の管理グループを指定してください
CategoryString−　カテゴリ256HW障害インシデント分類のカテゴリを指定してください
SubCategoryString−　サブカテゴリ256サブカテゴリインシデント分類のサブカテゴリを指定してください
RelatedSystemString−　関連システム/サービス65535ByteAsystemインシデント分類の関連システム/サービスを指定してください
RelatedCIString−　関連CI65535Byteシステム名称:Asystemインシデント分類の関連CIを指定してください
ImpactString−　サービス影響256有インシデント分類のサービス影響を指定してください
InfluenceString−　影響範囲2048全顧客インシデント分類の影響範囲を指定してください
CauseClassificationString−原因分類256性能不足インシデント分類の原因分類を指定してください
CauseString−　原因2048XXのメモリが不足していたためインシデント分類の原因を指定してください
ObstacleDetectionTimeString−　障害検知日時1420220630132400YYYYMMDDhhmmssの形式で指定してください
FaultRecoveryDateString−　障害復旧日時1420220630132500YYYYMMDDhhmmssの形式で指定してください
NodeNameString−　ノード名1024testnode_001障害情報のノード名を指定してください
EventIdString−　監視ID25412345障害情報の監視IDを指定してください
DetectionMessageString−　詳細65535Byteアラートを検知しました。
監視ID：12345		障害情報の詳細を指定してください
CorrespondStartDateString−　対応開始日時1420220630133000YYYYMMDDhhmmssの形式で指定してください
CorrespondFinishDateString−　対応終了日時1420220630135000YYYYMMDDhhmmssの形式で指定してください
CorrespondProcessList



Array−対応メモ-　登録、更新、削除する対応メモの情報のみを指定してください

CorrespondProcessSeq

String−対応メモ連番92何番目の対応メモについて処理するかを指定してください。
  • 登録時：空欄
  • 更新/削除時：情報取得APIにて取得した連番を指定
CorrespondProcessOperationClassString※対応メモ操作区分11

0：新規登録、1：編集、2：削除

※対応メモの登録/編集/削除を行う場合、必ず指定してください

CorrespondProcessString−　対応メモ2048障害発生に伴い、対応を開始する。対応状況の対応メモを指定してください
StateInsertDateString○ステータス登録日時1420220630132605形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください

StateUpdateDate

String○ステータス更新日時1420220630140000形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください

SummaryInsertDate

String○サマリ登録日時1420220630132605形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください

SummaryUpdateDate

String○サマリ更新日時1420220630140000形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください

CorrespondInsertDate

String○対応詳細登録日時1420220630132605形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください

CorrespondUpdateDate

String○対応詳細更新日時1420220630135000形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください
リクエストチケットを更新する場合
パラメータタイプ必須意味最大文字数リクエスト例備考
ServiceCodeString○サービスコード15uom12345678ご契約のサービスコードを指定してください
MasterIDString○マスターID15SA1234567API利用者のマスターIDを指定してください
TicketProcessTypeString○チケット種別22リクエストチケットを更新する場合、必ず「2」を指定してください
TitleString−　チケット件名256XXに関するお問い合わせ基本情報のチケット件名を指定してください
StateCodeString−　ステータス256新規

基本情報のステータスを指定してください

  • 新規
  • 対応中
  • クローズ承認待ち
  • 差し戻し
  • クローズ
SubStateCodeString−　サブステータス256未対応基本情報のサブステータスを指定してください
PriorityString○優先度256中

基本情報の優先度を指定してください

  • 高
  • 中
  • 低
SupportedGroupString−　担当グループ256お客様

基本情報の担当グループを指定してください

  • お客様
  • SEサポート
  • サポートセンター
AssignUserIdString−　担当者ID15SA1234567基本情報の担当者IDを指定してください（マスターIDのみを指定してください）
CorrespondLimitDateString−対応期限1420220630000000YYYYMMDDhhmmssの形式で指定してください
FinishApprovalUserIdString−　クローズ承認者ID15SA1234567基本情報のクローズ承認者IDを指定してください（マスターIDのみを指定してください）
UrgencyString−　緊急度256中リクエスト分類の緊急度を指定してください
ManagementGroupIdString−　管理グループ256制限しないリクエスト分類の管理グループを指定してください
RequestTypeString−　リクエストタイプ256問合せリクエスト分類のリクエストタイプを指定してください
RequestSubTypeString−　リクエストタイプサブタイプ256問合せ（システム）リクエスト分類のリクエストタイプサブタイプを指定してください
CategoryString−カテゴリ256カテゴリ1リクエスト分類のカテゴリを指定してください
SubCategoryString−　サブカテゴリ256サブカテゴリ1リクエスト分類のサブカテゴリを指定してください
RelatedSystemString−　関連システム/サービス65535ByteAsystemリクエスト分類の関連システム/サービスを指定してください
RepresentativeCustomerIdString−　依頼者ID15SA1234567依頼情報の依頼者名のマスターIDを指定してください（マスターID以外の値は指定しないでください）
RepresentativeCustomerNameString−　依頼者名200IIJ 太郎依頼情報の依頼者名の氏名または 依頼者の情報を指定してください
CustomerDepartmentString−　組織/部署200XX会社　XX部依頼情報の組織/部署を指定してください
CustomerContactInfoString−　連絡先200090-1234-5678依頼情報の連絡先を指定してください
RequestDateString−　依頼日時1420220630132400YYYYMMDDhhmmssの形式で指定してください
AcceptWayString−　受付手段256電話依頼情報の受付手段を指定してください
  • 電話
  • メール
  • ポータル
  • その他
RequestContentsString−　依頼内容65535ByteIPアドレス：XX.XXX.XX.XXX　にて障害を検知しているものの、正常な状態であるため、なぜ検知されているのか教えてほしいとの問合せ。依頼情報の依頼内容を指定してください
RespondWayString−　対応手段256メール

依頼情報の対応手段を指定してください

  • 電話
  • メール
  • ポータル
  • その他
RespondContentsString−　回答/対応内容2048設定画面でXXと設定すべきところYYと設定されているため。お客様にて設定の修正をしていただくよう、回答依頼情報の回答/対応内容を指定してください
CorrespondStartDateString−　対応開始日時1420220630133000YYYYMMDDhhmmssの形式で指定してください
CorrespondFinishDateString−　対応終了日時1420220630135000YYYYMMDDhhmmssの形式で指定してください
CorrespondProcessList



Array−　対応メモ-　登録、更新、削除する対応メモの情報のみを指定してください

CorrespondProcessSeq

String−　対応メモ連番92

何番目の対応メモについて処理するかを指定してください

  • 登録時：空欄
  • 更新/削除時：情報取得APIにて取得した連番を指定

CorrespondProcessOperationClass

String※対応メモ操作区分11

0：新規登録、1：編集、2：削除

※対応メモの登録/編集/削除を行う場合、必ず指定してください

CorrespondProcess

String−　対応メモ2048障害発生に伴い、対応を開始する。対応状況の対応メモを指定してください
StateInsertDateString○ステータス登録日時1420220630132605形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください
StateUpdateDateString○ステータス更新日時1420220630140000形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください
SummaryInsertDateString○サマリ登録日時1420220630132605形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください
SummaryUpdateDateString○サマリ更新日時1420220630140000形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください
CorrespondInsertDateString○対応詳細登録日時1420220630132605

形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください

CorrespondUpdateDateString○対応詳細更新日時1420220630135000形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください
DetailInsertDateString○詳細登録日時1420220630132605形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください
DetailUpdateDateString○詳細更新日時1420220630135000形式：YYYYMMDDhhmmss
チケット詳細情報取得APIにて取得した値をそのままセットしてください
2： レスポンス
正常終了
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時200が返却されます
Result
⁻結果
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
異常終了
フィールドタイプ意味備考
Result
⁻結果
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ErrorTypeStringエラータイプ異常終了となったエラータイプです
ErrorMessageStringエラーメッセージ異常終了となったエラーメッセージです
ErrorDetailStringエラーメッセージ異常終了となったエラーの詳細です
3： エラーメッセージ
エラーHTTP Status CodeErrorTypeErrorMessage説明備考
パラメータエラー200PARAMETER_REQUIRED必須項目が指定されていません。必須項目のうち、パラメータで指定されていない項目が存在します 「ErrorDetail」にて、どの必須項目の指定がされていないのか、確認できます
パラメータエラー200PARAMETER_TOO_LONG最大文字数を超過しています。指定されたパラメータのうち、最大文字数を超過している項目が存在します 「ErrorDetail」にて、どの項目が最大文字数を超過しているのか、確認できます
パラメータエラー200PARAMETER_ERROR指定できないパラメータが含まれています。指定されたパラメータに、リクエストパラメータとして使用できない項目が含まれています「ErrorDetail」にて、どの項目が使用できない項目なのか、確認できます
パラメータエラー200PARAMETER_ERROR空欄にできない項目が空文字で指定されています。チケットの情報のうち、必須項目など、空欄にはできない項目を、空欄に更新しようとしています「ErrorDetail」にて、どの項目が空欄にはできない項目なのか、確認できます
パラメータエラー200PARAMETER_ERROR入力パラメータが正しく指定されていません。

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

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

など

「ErrorDetail」にて、どの項目がエラーとなっているのか、確認できます
パラメータエラー200PARAMETER_ERRORステータスをクローズまたはクローズ承認待ちへ変更する場合、クローズ承認者の指定が必要です。

‐

‐
パラメータエラー200PARAMETER_ERRORクローズ承認者はステータスをクローズまたはクローズ承認待ちに変更する場合のみ指定してください。‐‐
パラメータエラー200PARAMETER_ERRORステータスがクローズ以外の場合、担当グループの値の指定が必要です。‐‐
パラメータエラー200PARAMETER_ERROR指定されたSAアカウントまたはサービスコードが不正です。‐‐
パラメータエラー200NO_TICKET_ID指定されたチケットIDのデータは存在しない、または閲覧権限がありません。‐‐
認証エラー200AUTH_FAILURE認証エラーです。‐‐
更新エラー200EXCLUSION_FAILURE他のユーザが指定されたチケットを更新しています。他のユーザが、同じチケットに対して更新操作を行っています。チケットの情報を再取得し、内容を確認してください‐
権限チェックエラー200NO_ROLES_TO_CLOSEステータスをクローズにする権限がありません。リクエストパラメータに指定している、MasterID（SAアカウント）に、承認権限がないため、チケットのステータスを「クローズ」に更新できません構成管理機能にて、操作を行うMasterIDに承認権限を付与するか、別のMasterIDでチケットの更新処理を実施してください
システムエラー200SYSTEM_ERRORシステムエラーが発生しました。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 = "UpdateTicket"
PARAMS = '{
	"ServiceCode" : "uom12345678",
	"TicketId":"UTM123456",
	"MasterID":"SA1234567",
	"TicketProcessType":"1",
	"StateInsertDate":"20221005143629",
	"StateUpdateDate":"20221005163649",
	"SummaryInsertDate":"20221005143630",
	"SummaryInsertDate":"20221005143630",
	"CorrespondInsertDate":"20221005143630",
	"CorrespondUpdateDate":"",
	"Title":"titleTest",
	"StateCode":"クローズ",
	"SubStateCode":"クローズ",
	"Priority":"中",
	"SupportedGroup":"お客様",
	"AssignUserId":"SA1234567",
	"CorrespondLimitDate":"20220801000000",
	"FinishApprovalUserId":"SA1234567",
	"Importance":"中",
	"Category":"アプリ障害",
	"SubCategory":"",
	"RelatedSystem":"Asystem",
	"RelatedCI":"関連CI",
	"Impact":"無",
	"Influence":"一部顧客",
	"CauseClassification":"性能不足",
	"Cause":"XXのメモリが不足していたため",
	"ObstacleDetectionTime":"20220630132400",
	"FaultRecoveryDate":"20220630132500",
	"NodeName":"NODE_NAME",
	"EventId":"12345",
	"DetectionMessage":"XXのアラートを検知",
	"CorrespondStartDate":"20220630133000",
	"CorrespondFinishDate":"20220630135000",
	"CorrespondProcessList":[{"CorrespondProcess":"updateTest",
			"CorrespondProcessSeq":"1",
			"CorrespondProcessOperationClass":"1"},
			{"CorrespondProcess":"",
			"CorrespondProcessSeq":"2",
			"CorrespondProcessOperationClass":"2"},
			{"CorrespondProcess":"addTest",
			"CorrespondProcessSeq":"",
			"CorrespondProcessOperationClass":"0"}]
}'
レスポンス（XML）

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

レスポンス（JSON）
正常終了
{
	"UpdateTicketResponse": {
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
	}
}

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