Storiq One API  v1.0
API for Storiq One
Report

Get a job report

use GET method

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

Report information

To get report by its id, use GET method

path : /storiqone-backend/api/v1/report/ 
Parameters
id: report id
Returns
HTTP status codes :
  • 200 Query succeeded
    Archive information is returned
    
    {
       "message":"Query successful","report": { ... }
    }
  • 401 Not logged in
  • 403 Permission denied
  • 500 Query failure

Report ids (multiple list)

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

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

Optional parameters

Name Type Description Constraint
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
To get multiple archives ids list do not pass an id or ids as parameter
Returns
HTTP status codes :
  • 200 Query succeeded
Archives ids list is returned
{
   {
   "message":"Query successful","reports":[2],"total_rows":1
   }
}
  • 400 Incorrect input
  • 401 Not logged in
  • 500 Query failure