Storiq One API  v1.0
API for Storiq One

Archive File information

To get archive file by its id, use GET method 

path : /storiqone-backend/api/v1/archivefile/
Parameters
id: archive file id
Returns
HTTP status codes :
  • 200 Query succeeded
  • 403 Permission denied
  • 404 Archive file not found
  • 500 Query failure

Archive files ids (multiple list)

To get archive files ids list, use GET method : Specify the archive id that you want to list 

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

Optional parameters

Name Type Description Constraint
order_by enum order by column value in : 'id', 'name', 'size'
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 the id list of archive files, specify the id of the archive you want to list
Returns
HTTP status codes :
  • 200 Query succeeded
  • 400 Incorrect input
  • 403 Permission denied
  • 500 Query failure

metaarchivefile ArchiveFile Metadata

Metadatas of archive files

To get metadatas from an archive file, use GET method : with a reference to an archive file id 

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

Metadata key of archive files

To get a metadata key of an archive file, use GET method : with a reference to an archive file id and a reference to a key 

path : /storiqone-backend/api/v1/archivefile/metadata
Returns
HTTP status codes :
  • 200 Query succeeded
  • 400 Incorrect input
  • 401 Not logged in
  • 404 Archivefile not found / Metadata not found
  • 500 Query failure

Update metadatas of archive files

To update metadatas of an archive file, use PUT method : with a reference to an archive file id and a reference to a key and a reference to a value 

path : /storiqone-backend/api/v1/archivefile/metadata/
Returns
HTTP status codes :
  • 200 Query succeeded
  • 400 Incorrect input
  • 401 Not logged in
  • 404 Archivefile not found / Metadata not found
  • 500 Query failure

Update metadatas of archive files

To create metadatas of an archive file, use POST method : with a reference to an archive file id and a reference to a key and a reference to a value 

path : /storiqone-backend/api/v1/archivefile/metadata/
Returns
HTTP status codes :
  • 200 Query succeeded
  • 400 Incorrect input
  • 401 Not logged in
  • 404 Archivefile not found / Metadata not found
  • 500 Query failure