システム管理API

説明概要

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

システム管理APIの種類

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

キャッシュクリアAPI

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

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

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

正常応答の例


 {"items":
   {"http:¥/¥/select.testserver.com¥/simple¥/yesno.xml":
     {"true":
       {"display":"Yes","value":"true"},
      "false":
       {"display":"No","value":"false"}
     }
   }
 }

キャッシュクリアAPI詳細

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

リクエストパラメータ

なし

レスポンス

items: キャッシュされている選択肢情報のマップ(Item)のリスト。キーが選択肢情報を格納しているURL、その値が選択肢の情報が保持されています。

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

なし

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

リクエストパラメータ

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

レスポンス

なし: 処理に成功した場合は、HTTPコード「200」が応答されます。指定した選択肢情報がキャッシュされていなかった場合でも同様です。

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

Validation: 10000