Storiq One API  v1.0
API for Storiq One

Pool information

To get pool by its id use GET method 

path : /storiqone-backend/api/v1/pool/
Parameters
id: pool id
Returns
HTTP status codes :
  • 200 Query succeeded 
    Pool information is returned
  • 401 Not logged in
  • 403 Permission denied
  • 404 Pool not found
  • 500 Query failure

Pools ids (multiple list)

To get pools id list, use GET method : without reference to specific id or ids 

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

Optional parameters

Name Type Description Constraint
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
To get multiple pools ids list do not pass an id or ids as parameter
Note
To find deleted pools, you must use the Searching pools (storiqone-backend/api/v1/pool/search/) and be logged in as Administrator.

Pool deletion

To delete a pool, use DELETE method : with pool id

Pool creation

To create a pool, use POST method with pool parameters (see table below). Mandatory parameters : name, archiveformat, mediaformat

Pool creation using a pool template

To create a pool based on a pool template, use POST method with the id of the pool template to use to create the pool, plus pool parameters (name, archiveformat, mediaformat, Pool template information)

Pool update

To update a pool, use PUT method with pool parameters (id, uuid, name, archiveformat, mediaformat, Pool Scripts) 

path : /storiqone-backend/api/v1/pool/
Name Type Value
id integer non NULL Default value, nextval('pool_id_seq'::regclass)
uuid uuid non NULL API generated if not provided
name character varying(64) non NULL
archiveformat integer non NULL
mediaformat integer non NULL
autocheck autocheckmode non NULL Default value, 'none'::autocheckmode
lockcheck boolean non NULL Default value, false
growable boolean non NULL Default value, false
unbreakablelevel unbreakablelevel non NULL Default value, 'none'::unbreakablelevel
rewritable boolean non NULL Default value, true
metadata json non NULL Default value, '{}'::json
backuppool boolean non NULL Default value, false
poolmirror integer _
scripts array of script _
deleted boolean non NULL Default value, false
Returns
HTTP status codes :
  • 200 Query succeeded
  • 400 Incorrect input
  • 401 Not logged in
  • 500 Query failure

Pool Scripts

Pool Scripts are executed for each job of the appropriate type, in sequence order.

Name Type Value
sequence integer non NULL
jobtype integer non NULL
script integer _
scripttype scripttype non NULL

Parameters

Name Type Description Constraint
sequence integer sequence number of the script sequence >= 0
jobtype integer jobtype of the script
script integer script number of the script
scripttype integer type of the script (one of "on error", "pre job" or "post job")