File Version

Get a file version, a file version's download URL, or a file version's preview URL.

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: GET /filesvc/api/v1/files/5ab067ba-e609-4d34-b470-5c55784217b3/versions/43b155ac-d712-4e51-c561-6d46794827b4?nsfilter=proj_DrZrSNrW

Get File Version

Gets a file version

Endpoints

GET /filesvc/api/v1/files/{id}/versions/{versionId}

Parameters

Query

• nsfilter - namespace context (Required)

Path

Parameter	Type	Description	Required
id	String	The file's id.	Required
versionId	String	The file version's id	Required

Response

Codes

Code	Description
200	Success
404	File or Version Not Found

Body

Code example

{  "_fileSize": 285165,  "_previews": [    {      "_id": "2290d60f-6af7-40c9-93be-8c924aed48c4",      "_width": 640,      "_height": 480,      "_fileVersionId": "4d45433b-85d1-44c1-829d-22adc7515c2e"    }  ],  "_id": "4d45433b-85d1-44c1-829d-22adc7515c2e",  "_metadata": {    "_updatedById": "35c74e68-32e2-47ae-8be6-c37aa0ac9976",    "_createdByName": "xxxxxxx",    "_createdAt": 1530089625693,    "_updatedByName": "xxxxxxx",    "_createdById": "35c74e68-32e2-47ae-8be6-c37aa0ac9976",    "_updatedAt": 1530089625693  },  "_version": 1,  "_fileId": "0947ea1a-dae3-4498-b4e3-0d4e7a3a4d37"}

Delete file version

Deletes a file version, If you delete the tip version then next latest version will be the tip version

Endpoints

DELETE /filesvc/api/v1/files/{id}/versions/{versionId}

Parameters

Query

• nsfilter - namespace context (Required)

Path

Parameter	Type	Description	Required
id	String	The file's id	Required
versionId	String	The file version's id	Required

Response

Codes

Code	Description
204	Success
404	File or Version Not Found

Get Download Url by File Version

Gets a file version's download URL.

Endpoints

GET /filesvc/api/v1/files/{id}/versions/{versionId}/url

Parameters

Query

• nsfilter - namespace context (Required)

Path

Parameter	Type	Description	Required
id	String	The file's id	Required
versionId	String	The file version's id	Required

Response

Codes

Code	Description
200	Success
404	File or Version Not Found

Body

Code example

{  "_fileSize": 285,  "_id": "4d45433b-85d1-44c1-829d-22adc7515c2e",  "_metadata": {    "_updatedById": "35c74e68-32e2-47ae-8be6-c37aa0ac9976",    "_createdByName": "xxxxxxxx",    "_createdAt": 1530089625693,    "_updatedByName": "xxxxxxxx",    "_createdById": "35c74e68-32e2-47ae-8be6-c37aa0ac9976",    "_updatedAt": 1530089625693  },  "_url": "xxxxx",  "_version": 1,  "_fileId": "0947ea1a-dae3-4498-b4e3-0d4e7a3a4d37"}

Get Preview Url by File Version

Gets a file version's preview URL.

Endpoints

GET /filesvc/api/v1/files/{id}/versions/{versionId}/previewurl

Parameters

Query

• nsfilter - namespace context (Required)

Path

Parameter	Type	Description	Required
id	String	The file's id	Required
versionId	String	The file version's id	Required

Query

Parameter	Type	Description	Required
width	Number	The file preview width. Currently, only 640 is supported.	Required
height	Number	The file preview height. Currently, only 480 is supported.	Required

Response

Codes

Code	Description
200	Success
404	File or Version Not Found

Body

Code example

{  "_fileSize": 285,  "_previewUrl": "xxxxx",  "_id": "4d45433b-85d1-44c1-829d-22adc7515c2e",  "_metadata": {    "_updatedById": "35c74e68-32e2-47ae-8be6-c37aa0ac9976",    "_createdByName": "xxxxxxx",    "_createdAt": 1530089625693,    "_updatedByName": "xxxxxxx",    "_createdById": "35c74e68-32e2-47ae-8be6-c37aa0ac9976",    "_updatedAt": 1530089625693  },  "_version": 1,  "_fileId": "0947ea1a-dae3-4498-b4e3-0d4e7a3a4d37"}