File Set

Grouping of graphics files used to stream in a single websocket connection. File Sets are ephemeral and will be removed on the termination of the socket connection. When creating a File Set, if a graphics file is not cached already then it will be downloaded to the cache before the File Set is created. It is advisable to cache the graphics file before using it in a File Set. The Iaf-Viewer can switch between files in a File Set on the same websocket connection.

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: POST /graphicssvc/api/vi/fileset?nsfilter=proj_DrZrSNrW

Create File Set

Creates a grouping of files to be used over a websocket connection

Endpoints

POST /graphicssvc/api/vi/fileset

Request

Query parameters

Parameter	Type	Description	Required
nsfilter	String	Filter by namespace.	Required

Body parameters

Parameter	Type	Description	Required
_files	Array of Object	Array of objects representing file ids and versions.	Required
_files._fileId	String	Id of requested file.	Required
_files._fileVersionId	String	Version of requested file.	Optional

Body example

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

Response

Response codes

Code	Description
200	Success
400	Bad Request

Response data example

{
  "_files": [
    {
      "_fileId": "da9a12ac-699c-4232-8c06-fc789eb9d6e5",
      "_fileVersionId": "26066d22-5fbc-1c89-cf3a-21038ffdbad2",
      "_fileName": "rac_basic.scz"
    },
    {
      "_fileId": "aa51b6b9-8c61-4bea-a5bf-66fd4d423f9e",
      "_fileVersionId": "81266d27-7fb6-4c80-bf3c-77038ffdbfd7",
      "_fileName": "NCH.scz"
    }
  ]
}

Get a File Set

Endpoints

GET /graphicssvc/api/vi/fileset/{fileSetId}

Request

Path parameters

Parameter	Type	Description	Required
fileSetId	String	The FileSet's id.	Required

Query parameters

Parameter	Type	Description	Required
nsfilter	String	Filter by namespace.	Required

Response

Response codes

Code	Description
200	Success
400	Bad Request
404	File Not Found

Response data example

{
  "_files": [
    {
      "_fileId": "da9a12ac-699c-4232-8c06-fc789eb9d6e5",
      "_fileVersionId": "26066d22-5fbc-1c89-cf3a-21038ffdbad2",
      "_fileName": "rac_basic.scz"

    },
    {
      "_fileId": "aa51b6b9-8c61-4bea-a5bf-66fd4d423f9e",
      "_fileVersionId": "81266d27-7fb6-4c80-bf3c-77038ffdbfd7",
      "_fileName": "NCH.scz"
    }
  ]
}

Delete a File Set

Endpoints

DELETE /graphicssvc/api/vi/fileset/{fileSetId}

Request

Path parameters

Parameter	Type	Description	Required
fileSetId	String	The FileSet's id.	Required

Query parameters

Parameter	Type	Description	Required
nsfilter	String	Filter by namespace.	Required

Response

Response codes

Code	Description
204	No Content
404	File Not Found

Response data

None