rDWS Files Endpoints

Base URL for these endpoints:  https://ws.bsn.cloud/rest/v1/

_________________________________________________________________________

GET /files/{:path}/ 

Lists the directories and/or files in a path

Segment

• path string: The path to the directories or files

Query String Parameter

• raw optional: Returns the raw contents of a directory

Request Example

Response Body

• type string: Either a directory or file

• path string: The path, for example, "sd"

• stat object: Directory stats from the "fs" module

• files object[ ]: 

  • name string:  Name of the file or directory

  • type string:  Either "file" or "dir"

  • path string: The relative path of the file or directory

  • stat object: File stats from the “fs” module

  • mime string: mime type (available only for type "file")

• storageInfo object: If the path in the URL is a storage device, this returns information about the storage device. For more information, see storageinfo. 

• fileSystemType string: The type of filesystem (for example, "fat32")

• stats object:

  • blockSize int: The size of a native block

  • bytesFree int: The amount of free space

  • filesFree int: The number of used inodes

  • filesUsed int: The number of free inodes

  • isReadOnly bool: A flag indicating whether the filesystem is read only

  • sizeBytes int: The amount of total space

• mountedOn string: The location where the file system is mounted (for example, "/storage/sd")

• contents object[ ]:

  • name string: The name of the file or directory

  • type string:  Either "file" or "dir"

  • path string:  The absolute path of the file or directory

  • stat object: The statistics from the "fs" module 

  • mime string: mime type (available only for type "file")

  • children object[ ]:  This is available only for directory types and will have the same format as "contents

Response Example

PUT /files/{:path}

Uploads a new file or folder to the player storage

Segment

• path string: The path is the folder in which you want to upload the file (for example: "/sd").

Request Body

• files object[]:

  • fileName string: The name of the file

  • fileContents string: The content of the file. It can be provided as plain text or as Data URL.

  • fileType string: Mime type

Request Example (File)

The following request example would be used with one of the two request body examples (Plain Text or Data URL) below:

In the request body examples below, use the FileReader's readAsText() or readAsDataURL() method to derive the fileContents value.

Plain Text Request Body: Any file with mime type "text/*", or any “brs”, “json”, “js”, “xml”, “rtf” extension, can be sent as plain text using FileReader's readAsText() method:

Data URL Request Body: For all other file types, including zip and media files, use the data URL format using FileReader's readAsDataURL() method:

Response Body

• success bool: A flag that indicates if the operation succeeded or not

• results string[]: The names of the files that were successfully created

Response Example (Plain Text File)

Request Example (Folder)

Response Example (Folder)

POST /files/{:path}/ 

Renames a file in the path (which should include the file name)

Segment

• path string: The path to the file (for example, /sd)

Request Example

This is the example request body:

Response Body

The player will return a success or error message.

DELETE /files/{:path}/ 

Deletes a file from the player storage

Segment

• path string: The path to the file (for example,/sd)

Request Example

Response Body

The player will return a success or error message.