ツール登録
ツールの情報を登録します。
(1) 必要な権限
RegisterTool APIを使用するには以下の権限が必要です。
-
システム管理の更新権限
管理対象種別による違いは以下のとおりです。
- システム全体
-
任意のツールの情報を登録可能
- グループ単位
-
使用不可
(2) リクエストURL
http(s)://Domain:xxxx/コンテキスト名/RegisterTool
(3) リクエストインタフェース
|
項目名 |
説明 |
文字 |
省略 |
省略値 |
|---|---|---|---|---|
|
tool_id |
ツールID ツールIDを32バイト以内で指定します。 |
半角 |
× |
|
|
tool_name |
ツール名 ツール名を128バイト以内で指定します。 |
混在 |
× |
|
|
tool_path |
ツール格納場所（*1） サーバ側のツール格納場所を255バイト以内で指定します。 |
半角 |
× |
|
|
comment |
コメント コメントを255バイト以内で指定します。 |
混在 |
○ |
ブランク |
|
*1 |
: |
プロパティファイル（env.properties）のtool.pathにパスが設定されている場合、そのパスからの相対パスを指定します。設定されていない場合はフルパスを指定します。 |
(4) レスポンスインタフェース
|
項目名 |
説明 |
備考 |
|---|---|---|
|
tool_id |
ツールID 正常に登録したツールIDが返却されます。 |
|