Storiq One API  v1.0
API for Storiq One

Pool template information

To get a pool template by its id use GET method

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

Pool templates ids (multiple list)

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

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

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 pool templates ids list do not pass an id or ids as parameter

Pool template deletion

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

Pool template creation

To create a pool template, use POST method with pool template parameters

Pool template update

To update a pool template, use PUT method with pool template parameters

path : /storiqone-backend/api/v1/pooltemplate/ 
Name Type Value
id integer non NULL Default value, nextval('pool_id_seq'::regclass)
name character varying(64) 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
createproxy boolean non NULL Default value, false
Returns
HTTP status codes :
  • 200 Query succeeded
  • 400 Incorrect input
  • 401 Not logged in
  • 403 Permission denied
  • 500 Query failure