システム管理API

説明概要

システム管理APIを説明します。
APIによっては、GET/POSTリクエストに対してJSONやXMLをレスポンスします。

システム管理APIの種類

キャッシュクリアAPI 選択型のデータ項目にて、「HTTP経由で取得した選択肢」や「選択肢マスタ」を定義したプロセスが存在する場合、実行時に取得したリスト結果の参照/クリアを行うAPIです。

キャッシュクリアAPI

操作 GET POST リクエストURL レスポンス(JSON) 実行に必要な権限
キャッシュされている選択肢の一覧を取得する ○ ○ <ContextRoot>/API/Admin/ItemCache/list urls システム管理権限
キャッシュされている選択肢の詳細情報を取得する ○ ○ <ContextRoot>/API/Admin/ItemCache/view count、items システム管理権限
キャッシュされている選択肢情報をクリアする ○ ○ <ContextRoot>/API/Admin/ItemCache/delete なし システム管理権限

「<ContextRoot>」は、DataSpider BPMのルートURIである「http(s)://<ホスト名>:<ポート番号>/userweb」を意味します。

キャッシュクリアAPIのレスポンス

正常応答の例


 {
   "urls":[
     "http:¥/¥/select.testserver.com¥/simple¥/yesno.xml",
     "file:¥/¥/¥/select¥/customer-list.xml"
   ]
 }



 {
   "count":2,
   "items":[
     {"display":"Yes","value":"true"},
     {"display":"No","value":"false"}
   ]
 }

キャッシュクリアAPI詳細

キャッシュされている選択肢の一覧を取得する: /API/Admin/ItemCache/list

GET/POST リクエストパラメータ

レスポンス

発生する可能性のあるエラー

キャッシュされている選択肢の詳細情報を取得する: /API/Admin/ItemCache/view

GET/POST リクエストパラメータ
パラメータ名 必須 説明
url 必須 取得したい選択肢が提供されているURL

レスポンス

発生する可能性のあるエラー

キャッシュされている選択肢情報をクリアする: /API/Admin/ItemCache/delete

GET/POST リクエストパラメータ
パラメータ名 必須 説明
url 必須 クリアする選択肢情報が提供されているURL

レスポンス

発生する可能性のあるエラー