GetOperationStopApplicationList
「UOMポータル」の「運用コントロールパネル」から「対応停止申請」を実施するのと同様に、申請されている対応停止申請の情報を取得できます。
| HTTPメソッド | Action | 名称 |
|---|---|---|
| POST | GetOperationStopApplicationList | 対応停止申請一覧取得 |
1： リクエストパラメータ
| パラメータ | タイプ | 必須 | 意味 | 最大文字数 | リクエスト例 | 備考 | |||
|---|---|---|---|---|---|---|---|---|---|
| OfficeId | String | ○ | 事業者コード | 11 | IIJ00000001 | 固定 | |||
| ServiceCode | String | ○ | サービスコード | 15 | uom12345678 | ご契約のサービスコードを指定してください | |||
| MasterId | String | ○ | 申請者マスターID | 15 | SA9876543 | マスターIDを指定してください | |||
| ApplyStateCode | String | ○ | 申請状態コード | 2 | 00 | 以下から指定してください
※カンマ区切りで複数指定可能 | |||
| NodeList | Array | − | ノードリスト | − | − | ノード単位の情報を格納したリストです | |||
| OperationNodeName | String | − | 運用対象ノード名 | 115 | uom12345678_testnode_001 | 先頭に”サービスコード_”を付与してください | |||
| MonitoringId | String | − | 監視ID | 30 | 12345 | ||||
| SearchDatetimeFrom | String | − | 検索適用開始日時 | 19 | 2017-07-07 10:10:30 | YYYY-MM-DD hh:mm:ssの形式で指定してください | |||
| SearchDatetimeTo | String | − | 検索適用終了日時 | 19 | 2017-07-20 10:10:30 | YYYY-MM-DD hh:mm:ssの形式で指定してください | |||
| SortObject | String | − | ソート項目 | 1 | 1 | 下記のみ利用可能です 1：申請受付番号 | |||
| SortOrder | String | − | ソート順 | 1 | 1 | 以下から指定してください
| |||
| Locale | String | ○ | 表示言語 | 1 | 0 | 下記のみ利用可能です 0：日本語 | |||
2： レスポンス
正常終了
| フィールド | タイプ | 意味 | 備考 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| StatusCode | String | ステータスコード | 成功時200が返却されます | ||||||||
| Result | − | 結果 | |||||||||
| RequestId | String | リクエストID | APIリクエストごとに割り当てられる一意なIDです | ||||||||
| NodeList | Array | ノードリスト | ノード単位の情報を格納したリストです | ||||||||
| OperationNodeName | String | 運用対象ノード名 | 先頭に”サービスコード_”を付与して返却されます （例）uom12345678_testnode_001 | ||||||||
| MonitoringId | String | 監視ID | |||||||||
| ReceptNo | String | 受付番号 | 申請を受け付けた番号が返却されます | ||||||||
| ReceptNoSubNo | String | 受付番号枝番 | |||||||||
| ApplyStateCode | String | 申請状態コード | 以下が返却されます
| ||||||||
| StartDatetime | String | 適用開始日時 | 形式：YYYY-MM-DD hh:mm:ss | ||||||||
| EndDatetime | String | 適用終了日時 | 形式：YYYY-MM-DD hh:mm:ss | ||||||||
異常終了
| フィールド | タイプ | 意味 | 備考 | |
|---|---|---|---|---|
| Result | − | 結果 | ||
| RequestId | String | リクエストID | APIリクエストごとに割り当てられる一意なIDです | |
| ErrorType | String | エラータイプ | 異常終了となったエラータイプです | |
| ErrorMessage | String | エラーメッセージ | 異常終了となったエラーメッセージです | |
3： エラーメッセージ
| エラー | HTTP Status Code | ErrorType | ErrorMessage | 説明 |
|---|---|---|---|---|
パラメータエラー | 400 | Parameter Error | There are invalid parameters. | パラメータの形式が無効 |
Webシステムエラー | 500 | UOM WebSystem Error | UOM 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."
}
}