Skip to main content
Version: v5.0

File Store

Cache of graphics files managed by the Graphics Service on a network storage. A graphics file is always downloaded from the FileService and added to the local FileStore. It can then be added to a FileSet to be streamed over a websocket connection to the Iaf-Viewer. Model import process calls the the API to add a model's graphics files to the FileStore after the model is imported.

Request for FileStore needs to have a valid bearer token in the Authentication header.

Note: The nsfilter (namespace filter) query parameter is mandatory for every request. It sets the context, helping you look up resources within that namespace. Example: PUT /graphicssvc/api/vi/filestore?nsfilter=proj_DrZrSNrW

Download#

Downloads asynchronously from the File Service to the local cache. Will download only the files with #invgraphicsfile# tag.

Endpoints#

PUT /graphicssvc/api/vi/filestore

Request#

Query parameters#

ParameterTypeDescriptionRequired
nsfilterStringFilter by namespace.Required

Body#

Array of objects with the following properties.

|_fileId|String|Id of requested file.|Required| |_fileVersionId|String|Version of requested file.|Optional|

Example:

[  {    "_fileId": "da9a12ac-699c-4232-8c06-fc789eb9d6e5"  },  {    "_fileId": "aa51b6b9-8c61-4bea-a5bf-66fd4d423f9e",    "_fileVersionId": "81266d27-7fb6-4c80-bf3c-77038ffdbfd7"  }]

Response#

Response codes#

CodeDescription
200Success
400Bad Request
404File Not Found

Response#

None