BrightSign Network Web API Reference Manual v.3.8 User Manual
Page 38
26
o [string] virtualPath: The path in the BSN Library to which the file should be uploaded. If the path
does not exist, it will be created. It must also contain leading and trailing slashes and be no longer than 128
characters.
o [string] relativePath: The relative path of the associated asset file in relation to the webpage HTML
file.
o [string] sha1Hash: The SHA1 hash of the current file. The server performs verification of the uploaded
file using the specified hash. A descriptive error will be returned if the specified hash does not match the
hash value calculated by the server. This parameter is optional; the server-side hash verification process is
skipped if this parameter is not specified.
o [string] webpageAssetId
•
[string] filename: The name of the webpage file to be uploaded. A descriptive error will be returned if any of
the following conditions occur:
o This string is empty.
o The string has more than 128 characters.
o The file name is not valid.
•
[long] filesize: The size of the webpage in bytes. This parameter must be an unsigned integer value no
greater than 5000000000 (i.e. 5GB). A descriptive error will be returned if the value is negative.
•
[int] chunksCount: The number of chunks the file consists of (starting at 1). The optimal chunk size is 256KiB.
Files that are larger than this chunk size must be split into smaller parts by the client. Multiple chunks should be
uploaded using multiple
AppendChunk() calls specifying the same upload token.
•
[enum: Auto, Image, Video, Audio, Webpage] contentType: The type of the content file, which
should be specified as “Webpage”.
•
[string] virtualPath: The path in the BSN Library to which the file should be uploaded (the default is
“\Shared\Incoming\”). If the path does not exist, it will be created. It must also contain leading and trailing slashes
and be no longer than 128 characters.
•
[base64Binary] fileThumb: The optional thumbnail data as a binary attachment. This parameter will be
generated by the server if it is not specified.