GetOperationStopApplicationList

「UOMポータル」の「運用コントロールパネル」から「対応停止申請」を実施するのと同様に、申請されている対応停止申請の情報を取得できます。

HTTPメソッドAction名称
POSTGetOperationStopApplicationList対応停止申請一覧取得
1: リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
OfficeIdString事業者コード11IIJ00000001固定
ServiceCodeStringサービスコード15uom12345678ご契約のサービスコードを指定してください
MasterIdString申請者マスターID15SA9876543マスターIDを指定してください
ApplyStateCodeString申請状態コード200

以下から指定してください

00:受理待ち

10:受理

20:完了

80:否認

(カンマ区切りで複数指定可能)

NodeList Arrayノードリストノード単位の情報を格納したリストです
OperationNodeNameString運用対象ノード名115uom12345678_testnode_001先頭に”サービスコード_”を付与してください
MonitoringIdString監視ID3012345 
SearchDatetimeFromString検索適用開始日時

19

2017-07-07 10:10:30YYYY-MM-DD hh:mm:ssの形式で指定してください
SearchDatetimeToString検索適用終了日時192017-07-20 10:10:30YYYY-MM-DD hh:mm:ssの形式で指定してください
SortObjectStringソート項目11

下記のみ利用可能です

1:申請受付番号

SortOrderStringソート順11

以下から指定してください

1:昇順

2:降順

LocaleString表示言語10

下記のみ利用可能です

0:日本語

2: レスポンス
正常終了
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時200が返却されます
Result 結果 
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
NodeList Arrayノードリストノード単位の情報を格納したリストです
OperationNodeNameString運用対象ノード名

先頭に”サービスコード_”を付与して返却されます

(例)uom12345678_testnode_001

MonitoringIdString監視ID 
ReceptNoString受付番号申請を受け付けた番号が返却されます
ReceptNoSubNoString受付番号枝番 
ApplyStateCodeString申請状態コード

以下が返却されます

00:受理待ち

10:受理

20:完了

80:否認

StartDatetimeString適用開始日時形式:YYYY-MM-DD hh:mm:ss
EndDatetimeString適用終了日時

形式:YYYY-MM-DD hh:mm:ss

異常終了
フィールドタイプ意味備考
Result 結果 
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ErrorTypeStringエラータイプ異常終了となったエラータイプです
ErrorMessageStringエラーメッセージ異常終了となったエラーメッセージです

3: エラーメッセージ
エラーHTTP Status CodeErrorTypeErrorMessage説明備考

パラメータエラー

400Parameter ErrorThere are invalid parameters.パラメータの形式が無効 

Webシステムエラー

500UOM WebSystem ErrorUOM Web System error occurred.システム障害 
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 = "GetOperationStopApplicationList"
PARAMS = '{
	"OfficeId" : "IIJ00000001",
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"ApplyStateCode" : "00",
	"NodeList" :[
		{"OperationNodeName":"uom12345678_testnode_001",
		"MonitoringId":"12345"},
		{"OperationNodeName":"uom12345678_testnode_002",
		"MonitoringId":"98765"}
	],
	"SearchDatetimeFrom" : "2017-07-07 10:10:30",
	"SearchDatetimeTo" : "2017-07-20 10:10:30",
	"SortObject" : "1",
	"SortOrder" : "1",
	"Locale" : "0"
}'
レスポンス(XML)

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

レスポンス(JSON)
正常終了
{
	"GetOperationStopApplicationListResponse":{
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"NodeList":[
			{"MonitoringId":"12345",
			"StartDatetime":"2015-12-08 00:00:00",
			"ReceptNo":"SUOM0000-0000",
			"OperationNodeName":"-",
			"ReceptNoSubNo":"01",
			"EndDatetime":"2016-12-06 00:00:00",
			"ApplyStateCode":"10"},
			{"MonitoringId":"12345",
			"StartDatetime":"2015-12-08 00:00:00",
			"ReceptNo":"SUOM0000-0000",
			"OperationNodeName":"-",
			"ReceptNoSubNo":"01",
			"EndDatetime":"2016-12-06 00:00:00",
			"ApplyStateCode":"10"}
		]
	}
}
異常終了
{
	"ErrorResponse":{
		"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"ErrorType":"UOMWebSystemError",
		"ErrorMessage":"UOM Web System error occurred."
	}
}