baculum: Update api endpoints documentation

diff --git a/docs/manuals/en/console/baculum.tex b/docs/manuals/en/console/baculum.tex
index 35f940cccb7ffe718f39d9beb3c36ee919fb48b2..1c72d587dfce9fe509a8425206cd3fbe5d7c503b 100644 (file)
--- a/docs/manuals/en/console/baculum.tex
+++ b/docs/manuals/en/console/baculum.tex
@@ -494,6 +494,8 @@ Errors:
 
 10 - Client with inputted clientid does not exists.
 
+11 - Bconsole support is disabled.
+
 1000 - Internal error.
 
 \subsection{Storages}
@@ -535,6 +537,8 @@ Errors:
 
 7 - Access attempt to not allowed resource. Permission denied.
 
+11 - Bconsole support is disabled.
+
 20 - Storage with inputted storageid does not exists.
 
 1000 - Internal error.
@@ -553,6 +557,9 @@ GET /api/volumes/purge/5 - call purge action on volume with mediaid equal 5.
 
 GET /api/volumes/jobs/5 - get all jobs done on volume with mediaid equal 5.\\
 
+GET /api/volumes/required/7/1234/ - get all volumes required to restore file
+ with fileid equal 1234 and jobid equal 7.
+
 
 Errors:
 
@@ -572,6 +579,8 @@ Errors:
 
 7 - Access attempt to not allowed resource. Permission denied.
 
+11 - Bconsole support is disabled.
+
 30 - Volume with inputted mediaid does not exists.
 
 1000 - Internal error.
@@ -609,6 +618,8 @@ Errors:
 
 7 - Access attempt to not allowed resource. Permission denied.
 
+11 - Bconsole support is disabled.
+
 40 - Pool with inputted poolid does not exists.
 
 1000 - internal error.\\
@@ -740,36 +751,48 @@ POST /api/jobs/run/ - call run action on job (run job).
 POST /api/jobs/restore/ - call restore action.
 
 \begin{verbatim}
-+-----------------------------------------------------------------------------+
-|                      /api/jobs/restore/ POST request                        |
-+-------------------+---------+-----------------------------------------------+
-| Name              |  Type   |    Description                                |
-+-------------------+---------+-----------------------------------------------+
-| create[rpath] *   | string  | Bvfs temporary table name for restore purpose |
-|                   |         | in form: b2[0-9]+                             |
-+-------------------+---------+-----------------------------------------------+
-| create[clientid] *| integer | Client identifier                             |
-|                   |         | (used instead of client name)                 |
-+-------------------+---------+-----------------------------------------------+
-| create[client] *  | string  | Client name (used instead of client id)       |
-|                   |         |                                               |
-+-------------------+---------+-----------------------------------------------+
-| create[priority]  | integer | Job priority to run                           |
-|                   |         |                                               |
-+-------------------+---------+-----------------------------------------------+
-| create[where] *   | string  | Destination directory for restored files      |
-|                   |         |                                               |
-+-------------------+---------+-----------------------------------------------+
-| create[replace] * | string  | Replace files in destination directory for    |
-|                   |         | restored files. Available options:            |
-|                   |         | - never                                       |
-|                   |         | - ifolder                                     |
-|                   |         | - ifnewer                                     |
-|                   |         | - always                                      |
-+-------------------+---------+-----------------------------------------------+
-| create[restorejob]| string  | Restore job name                              |
-| *                 |         |                                               |
-+-------------------+---------+-----------------------------------------------+
++-------------------------------------------------------------------------------+
+|                       /api/jobs/restore/ POST request                         |
++---------------------+---------+-----------------------------------------------+
+| Name                |  Type   |    Description                                |
++---------------------+---------+-----------------------------------------------+
+| create[rpath] *     | string  | Bvfs temporary table name for restore purpose |
+|                     |         | in form: b2[0-9]+                             |
++---------------------+---------+-----------------------------------------------+
+| create[clientid] *  | integer | Client identifier                             |
+|                     |         | (used instead of client name)                 |
++---------------------+---------+-----------------------------------------------+
+| create[client] *    | string  | Client name (used instead of client id)       |
+|                     |         |                                               |
++---------------------+---------+-----------------------------------------------+
+| create[priority]    | integer | Job priority to run                           |
+|                     |         |                                               |
++---------------------+---------+-----------------------------------------------+
+| create[where] *     | string  | Destination directory for restored files      |
+|                     |         |                                               |
++---------------------+---------+-----------------------------------------------+
+| create[replace] *   | string  | Replace files in destination directory for    |
+|                     |         | restored files. Available options:            |
+|                     |         | - never                                       |
+|                     |         | - ifolder                                     |
+|                     |         | - ifnewer                                     |
+|                     |         | - always                                      |
++---------------------+---------+-----------------------------------------------+
+| create[restorejob]  | string  | Restore job name                              |
+|                     |         |                                               |
++---------------------+---------+-----------------------------------------------+
+| create[strip_prefix]| string  | Strip prefix from restored paths /etc         |
+|                     |         |                                               |
++---------------------+---------+-----------------------------------------------+
+| create[add_prefix]  | string  | Add prefix to restored paths /tmp/myetc       |
+|                     |         | It can't be used with 'where' parameter       |
++---------------------+---------+-----------------------------------------------+
+| create[add_suffix]  | string  | Add suffix to restored path e.g. .old         |
+|                     |         |                                               |
++---------------------+---------+-----------------------------------------------+
+| create[regex_where] | string  | Pattern matched for each restored path        |
+|                     |         | e.g. !a.pdf!a.bkp.pdf!                        |
++---------------------+---------+-----------------------------------------------+
 
 * - required field
 \end{verbatim}
@@ -794,6 +817,8 @@ Errors:
 
 7 - Access attempt to not allowed resource. Permission denied.
 
+11 - Bconsole support is disabled.
+
 50 - Job with inputted jobid does not exist.
 
 51 - Inputed job level is invalid.
@@ -899,6 +924,10 @@ POST /api/bvfs/restore/ - preparing Bvfs paths for restore command.
 | create[fileid]    | string  | file identifiers comma separated              |
 |                   |         |                                               |
 +-------------------+---------+-----------------------------------------------+
+| create[findex]    | string  | comma separated pairs jobid and fileindex e.g.|
+|                   |         | jobid1,findex1,jobid2,findex2                 |
+|                   |         | Used to restore hardlinks                     |
++-------------------+---------+-----------------------------------------------+
 | create[path] *    | string  | temporary Bvfs table table name               |
 |                   |         | in form b2[0-9]+                              |
 +-------------------+---------+-----------------------------------------------+
@@ -927,10 +956,22 @@ Errors:
 
 7 - Access attempt to not allowed resource. Permission denied.
 
-70 - Job with inputted jobid does not exist.
+11 - Bconsole support is disabled.
 
 71 - Inputted path for restore is invalid. Proper format is b2[0-9]+.
 
+72 - Inputted BVFS path param is invalid.
+
+73 - Invalid jobid list.
+
+74 - Invalid fileid list.
+
+75 - Invalid file index list.
+
+76 - Invalid dirid list.
+
+77 - Invalid client name.
+
 1000 - Internal error.
 
 \subsection{Config}