Storiq One API  v1.0
API for Storiq One

searcharchive Search Archive

Searching archives

To search archives and then to get archives ids list, use GET method : 

path : /storiqone-backend/api/v1/archive/search

Optional parameters

Name Type Description Constraint
name string search an archive specifying its name
uuid string search an archive specifying its uuid
owner string or integer search an archive specifying its owner
creator string or integer search an archive specifying its creator
archivefile string or integer search an archive specifying its file
media integer search an archive specifying its media
pool string or integer search an archive specifying its pool
poolgroup integer search an archive specifying its poolgroup
order_by enum order by column value in : 'id', 'uuid', 'name', 'creator', 'owner'
order_asc boolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing.
limit integer specifies the maximum number of rows to return. limit > 0
offset integer specifies the number of rows to skip before starting to return rows. offset >= 0

| status | string | search archive files given the status | status = checked || status = not_checked || status = not_ok | | meta | string | search archive files given conditions | , = AND & | = OR |

Warning
Make sure to pass at least one of the first four parameters. Otherwise, do not pass them to get the complete list.
Returns
HTTP status codes :
  • 200 Query succeeded
Archives ids list is returned
{
   {
   "message":"Query successful","archives":[2],"total_rows":1
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 404 Archives not found
  • 500 Query failure

searcharchivefile Search Archive File

Searching archive files

To search archive files and then to get archive files ids list, use GET method : 

path : /storiqone-backend/api/v1/archivefile/search

Optional parameters

Name Type Description Constraint
name string search an archive file specifying its name
archive integer search an archive file given the archive id
archive_name string search an archive file given the archive name
mimetype string search an archive file specifying its mime type
order_by enum order by column value in : 'id', 'size', 'name', 'type', 'owner', 'groups'
order_asc boolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing.
limit integer specifies the maximum number of rows to return. limit > 0
offset integer specifies the number of rows to skip before starting to return rows. offset >= 0
size integer search archive files given the size size >= 0
size_inf integer search archive files given the minimum size size_inf >= 0 & > size_sup
size_sup integer search archive files given the maximum size size_sup >= 0 & < size_inf
date date search archive files given the date valid date
date_inf date search archive files given the minimum date valid date & date_inf > date_sup
date_sup date search archive files given the maximum date valid date & date_sup < date_inf
version integer search archive files given the version version >= 0
version_inf integer search archive files given the minimum version version_inf >= 0 & > version_sup
version_sup integer search archive files given the maximum version version_sup >= 0 & < version_inf

| status | string | search archive files given the status | status = checked || status = not_checked || status = not_ok | | meta | string | search archive files given conditions | , = AND & | = OR |

Warning
Make sure to pass at least one of the first four parameters. Otherwise, do not pass them to get the complete list.
Returns
HTTP status codes :
  • 200 Query succeeded
Archive files ids list is returned
{
   {
   "message":"Query successful","archivefiles":[2]
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 404 Archivefiles not found
  • 500 Query failure

devicesearch

Searching devices

To search devices and then to get devices ids list, use GET method : 

path : /storiqone-backend/api/v1/device/search

Optional parameters

Name Type Description Constraint
isonline string search a device specifying if it is online 't' for true, 'f' for false
enable string search a device specifying if it is enabled 't' for true, 'f' for false
model string search a device specifying its model
vendor string search a device specifying its vendor
order_by enum order by column value in : 'id', 'model', 'vendor'
order_asc boolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing.
limit integer specifies the maximum number of rows to return. limit > 0
offset integer specifies the number of rows to skip before starting to return rows. offset >= 0
Warning
Make sure to pass at least one of the first four parameters. Otherwise, do not pass them to get the complete list.
Returns
HTTP status codes :
  • 200 Query succeeded
devices ids list is returned
{
   {
   "message":"Query successful","devices":[2],"total_rows":1
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 404 Devices not found
  • 500 Query failure

jobsearch

Searching jobs

To search jobs and then to get jobs ids list, use GET method : 

path : /storiqone-backend/api/v1/job/search

Optional parameters

Name Type Description Constraint
name string search a job specifying its name
pool integer search a job specifying its pool
login integer search a job specifying the login number of the user which planned it
type integer search a job specifying its type
status csv search a job specifying its status, allow comma separated values
archive integer search a job specifying its archive
media integer search a job specifying its media
order_by enum order by column value in : 'id', 'size', 'name', 'type', 'owner', 'groups'
order_asc boolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing.
limit integer specifies the maximum number of rows to return. limit > 0
offset integer specifies the number of rows to skip before starting to return rows. offset >= 0
Warning
Make sure to pass at least one of the first six parameters. Otherwise, do not pass them to get the complete list.
Returns
HTTP status codes :
  • 200 Query successful
Jobs ids list is returned
{
   {
   "message":"Query successful","jobs_id" => [2], "total_rows" => 1
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 404 Jobs not found
  • 500 Query failure

searchmedia Search Media

Searching medias

To search medias and then to get medias ids list, use GET method : 

path : /storiqone-backend/api/v1/media/search

Optional parameters

Name Type Description Constraint
name string search a media specifying its name
label string search a media specifying its barcode
pool integer or string search a media specifying its pool by id or name
nbfiles integer search a media specifying the number of files
archiveformat integer search a media specifying its archiveformat
mediaformat integer search a media specifying its mediaformat
type string search a media specifying its type
order_by enum order by column value in : 'id', 'pool', 'nbfiles', 'poolgroup'
order_asc boolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing.
limit integer specifies the maximum number of rows to return. limit > 0
offset integer specifies the number of rows to skip before starting to return rows. offset >= 0
Warning
Make sure to pass at least one of the first seven parameters. Otherwise, without parameters search returns the list of all media.
Note
if pool is null then media without pool are returned
Returns
HTTP status codes :
  • 200 Query succeeded
Medias ids list is returned
{
   {
   "message":"Query succeeded","medias" => [2]
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 403 Permission denied
  • 404 Pools not found
  • 500 Query failure

poolsearch

Searching pools

To search pools and then to get pools ids list, use GET method : 

path : /storiqone-backend/api/v1/pool/search

Optional parameters

Name Type Description Constraint
name string search a pool specifying its name
deleted string should be 'yes', 'no', 'only'. default value 'non'
poolgroup integer search a pool specifying its poolgroup
mediaformat integer search a pool specifying its mediaformat
backuppool boolean search a backup used for backup if true. search all pools if not specified.
order_by enum order by column value in : 'id', 'uuid', 'name'
order_asc boolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing.
limit integer specifies the maximum number of rows to return. limit > 0
offset integer specifies the number of rows to skip before starting to return rows. offset >= 0
Warning
Make sure to pass at least one of the first three parameters. Otherwise, do not pass them to get the complete list.
Returns
HTTP status codes :
  • 200 Query succeeded
Pools ids list is returned
{
   {
   "message":"Query succeeded","pools" => [2]
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 403 Permission denied
  • 404 Pools not found
  • 500 Query failure

poolgroup

Searching poolgroups

To search pollgroups and then to get poolgroups ids list, use GET method : 

path : /storiqone-backend/api/v1/poolgroup/search

Optional parameters

Name Type Description Constraint
name string search a poolgroup specifying its name
uuid string search a poolgroup specifying its uuid
order_by enum order by column value in : 'id', 'uuid', 'name'
order_asc boolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing.
limit integer specifies the maximum number of rows to return. limit > 0
offset integer specifies the number of rows to skip before starting to return rows. offset >= 0
Warning
Make sure to pass at least one of the first two parameters to make a specific search. Otherwise, do not pass them to get the complete list.
Returns
HTTP status codes :
  • 200 Query succeeded
Poolgroups ids list is returned
{
   {
   "message":"Query succeeded","poolgroups" => [2]
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 403 Permission denied
  • 404 Users not found
  • 500 Query failure

searchpoolmirror

Searching pool mirrors

To search pool mirrorss and then to get pool mirrors ids list, use GET method : 

path : /storiqone-backend/api/v1/poolmirror/search

Optional parameters

Name Type Description Constraint
name string search a pool mirror specifying its name
synchronized string search pool mirrors specifying if they are synchronized 't' for true, 'f' for false
order_by enum order by column value in : 'id', 'uuid', 'name'
order_asc boolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing.
limit integer specifies the maximum number of rows to return. limit > 0
offset integer specifies the number of rows to skip before starting to return rows. offset >= 0
Warning
Make sure to pass at least one of the first two parameters to make a specific search. Otherwise, do not pass them to get the complete list.
Returns
HTTP status codes :
  • 200 Query succeeded
Pool mirrors ids list is returned
{
   {
   "message":"Query succeeded","poolmirrors" => [2]
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 403 Permission denied
  • 404 Pool mirrors not found
  • 500 Query failure

searchpooltemplate

Searching pool templates

To search pool templates and then to get pool templates ids list, use GET method : 

path : /storiqone-backend/api/v1/pooltemplate/search

Optional parameters

Name Type Description Constraint
name string search a pool template specifying its name
autocheck string search pool templates specifying their autocheck 't' for true, 'f' for false
lockcheck string search pool templates specifying their lockcheck 't' for true, 'f' for false
rewritable string search pool templates specifying if they are rewritable 't' for true, 'f' for false
order_by enum order by column value in : 'id', 'name'
order_asc boolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing.
limit integer specifies the maximum number of rows to return. limit > 0
offset integer specifies the number of rows to skip before starting to return rows. offset >= 0
Warning
Make sure to pass at least one of the first four parameters to make a specific search. Otherwise, do not pass them to get the complete list.
Returns
HTTP status codes :
  • 200 Query succeeded
Pool templates ids list is returned
{
   {
   "message":"Query succeeded","pooltemplates" => [2]
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 403 Permission denied
  • 404 Pool templates not found
  • 500 Query failure

user

Searching users

To search users and then to get users ids list, use GET method : 

path : /storiqone-backend/api/v1/user/search

Optional parameters

Name Type Description Constraint
login string search a user specifying its login
poolgroup integer search a user specifying its poolgroup
isadmin string search a user specifying if the user is admin or not 't' for true, 'f' for false
canarchive string search a user specifying if the user can archive or not 't' for true, 'f' for false
canrestore string search a user specifying if the user can restore or not 't' for true, 'f' for false
disabled string search a user specifying if the user is disabled or not 't' for true, 'f' for false
order_by enum order by column value in : 'id', 'uuid', 'name'
order_asc boolean TRUE will perform an ascending order and FALSE will perform an descending order.
order_asc is ignored if order_by is missing.
limit integer specifies the maximum number of rows to return. limit > 0
offset integer specifies the number of rows to skip before starting to return rows. offset >= 0
Warning
Make sure to pass at least one of the first six parameters to make a specific search. Otherwise, do not pass them to get the complete list.
Returns
HTTP status codes :
  • 200 Query succeeded
Users ids list is returned
{
   {
   "message":"Query succeeded","users" => [2]
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 403 Permission denied
  • 404 Users not found
  • 500 Query failure