Use this endpoint to upload files to the network. Webpages are uploaded as a collection of files in an upload session, while all other files are uploaded individually without a session marker.
Calls to the /sessions/ endpoints require unique Accept and Content-Type header values (outlined below). Failing to include these header values will prompt a code 406 response from the server.
Unlike other BSN REST endpoints, the upload URL contains the "upload" path before the API version.
Base URL for this endpoint: https://api.brightsignnetwork.com/upload/2017/01/REST/sessions/
Upload Workflow
Webpages
These steps outline how to upload a webpage (i.e. an HTML file and associated asset files)
- The client makes a POST call to the
/sessions/endpoint with the following Content-Type value:application/vnd.bsn.start.webpage.upload.arguments.201701+json. The POST request body includes information about the HTML file and associated asset files (including the path of each asset file relative to the HTML file).- The response body includes a token for the webpage-upload session, as well as an upload token for each file that is part of the webpage.
- The client begins uploading the webpage HTML file by calling PUT on the
/sessions/{sessionToken}/uploads/{uploadToken}/endpoint with the following Content-Type value:application/vnd.bsn.start.webpage.asset.upload.arguments.201701+json. - The client uploads the file to the server by calling POST on the
/sessions/{sessionToken}/uploads/{uploadToken}/chunks/endpoint. If the file is larger than approximately 256KB, the client will need to make multiple POST calls and use the?offsetURL parameter to segment the file into chunks. - Once the file chunk(s) have been uploaded, the client completes the HTML file upload by calling PUT on the
/sessions/{sessionToken}/uploads/{uploadToken}/endpoint with the following Content-Type value:application/vnd.bsn.complete.webpage.asset.upload.arguments.201701+json. - The client repeats steps 2 through 4 for each asset file associated with the HTML file.
- Once all files have been uploaded, the client completes the webpage-upload session by calling PUT on the
/sessions/{sessionToken}/endpoint with the following Content-Type:application/vnd.bsn.complete.webpage.upload.arguments.201701+json. The response body will include the newcontentIdvalues of the uploaded HTML and asset files.
| Note | ||
|---|---|---|
| ||
All files must be specified in the initial POST call to the |
Endpoints:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Individual Files
These steps outline how to upload a single, independent file (such as a content file or plugin script).
- The client makes a POST call to the
/sessions/None/uploads/endpoint with the following Content-Type value:application/vnd.bsn.start.content.upload.arguments.201701+json. The POST request body includes information about the file.- The response body includes an upload token for the file.
- The client uploads the file to the server by calling POST on the
/sessions/None/uploads/{uploadToken}/chunks/endpoint. If the file is larger than approximately 256KB, the client will need to make multiple POST calls and use the?offsetURL parameter to segment the file into chunks. - The client completes the upload by calling PUT on the
/sessions/None/uploads/{uploadToken}/endpoint with the following Content-Type value:application/vnd.bsn.complete.content.upload.arguments.201701+json.
| Note | ||
|---|---|---|
| ||
Unlike other endpoints, the |
GET
Retrieves currently active webpage-upload sessions.
Parameters
marker: A value specifying which page to retrieve. This value is useful if theisTruncatedentry in the response body of the previous GET call indicates that the number of WebpageUploadStatus instances exceeds thepageSize.filter: An expression for filtering search results.pageSize: The maximum number of WebpageUploadStatus instances that can be contained in the response body
Headers
Accept: application/vnd.bsn.webpage.upload.status.pagedlist.201701+json
Response Body
[int] totalItemCount: The total number of WebpageUploadStatus instances relevant to the query[int] pageSize: The maximum number of WebpageUploadStatus instances that can be returned in a single response[bool] isTruncated: A flag indicating whether the totalItemCount exceeds the pageSize[string] nextMarker: A value that can be included with a subsequent GET call to return additional results that have been truncated[string] sortExpression: The sort expression specified in the URL[string] filterExpression: The filter expression specified in the URL[WebpageUploadStatus[]]items: An array of WebpageUploadStatus object instances representing active webpage-upload sessions. Each WebpageUploadStatus instance can have the following entries: [string] name: The name of the webpage (i.e. the collection of files that make up the webpage)
[string] sessionToken: A unique identifier for the webpage-upload session[string] uploadToken: A unique identifier for the HTML-file upload session[int] contentId: A unique identifier for the Content instance associated with the file being uploaded. This value is 0 while the upload session is in-progress.[string] fileName: The name of the file being uploaded[string] sha1Hash: The SHA1 hash value of the file contents[string] state: The current state of the content upload session. The following are possible state values: "unknown""queued""started""uploading""stopped""uploaded""verified""cancelled""corrupted""collected""terminated""completed"
[string] startTime: A UTC timestamp indicating when the content upload session began. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.[string] endTime: A UTC timestamp indicating when the content upload session ended. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.[string] lastActivityTime: A UTC timestamp indicating the last activity relating to the content upload session. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.[Chunk[]]chunks: An array of Chunk object instances representing chunks of the file. Each Chunk instance can have the following entries:[int] count: The number of chunks with the specifiedlengthandstate. A zero value is used for the section of the file that has not been uploaded/queued yet.[int] length: The byte length of the chunk(s)[string] state: The upload 6545163 of the chunk(s)
[WebPageAsset[]]assets: An array of WebPageAsset object instances representing asset files that are part of the webpage. The server currently returns a null value for this parameter. POST
Creates a new webpage-upload session for the webpage and its asset files. This operation returns a token for the entire webpage-upload session, as well as a token for each asset-file upload.
Headers
Content-Type: application/vnd.bsn.start.webpage.upload.arguments.201701+json-or- application/vnd.bsn.start.webpage.update.arguments.201701+json
Accept: application/vnd.bsn.webpage.upload.status.201701+json, application/vnd.bsn.error+json
Request Body
[string] name: The name of the webpage (i.e. the collection of files that make up the webpage)[string] fileName: The name of the HTML file[string] mediaType: The media type, which must be "Webpage" for the HTML file[int] fileSize: The size of the HTML file (in bytes)[string] sha1Hash: The SHA1 hash value of the file contents[WebPageAsset[]]assets: An array of WebPageAsset object instances representing asset files to upload as part of the webpage. Each WebPageAsset instance can have the following entries:[string] fileName: The name of the asset file[string] relativePath: The path of the asset file relative to the HTML file. The path should be formatted as follows: "\\[directoryA]\\[directoryAb]\\[...]".[int] fileSize: The size of the asset file (in bytes)[string] mediaType: The media type of the asset file. The following are accepted types: "Auto""Text""Image""Video""Audio""Webpage""DeviceWebpage"
[string] sha1Hash: The SHA1 hash value of the file contentsResponse Body
[string] name: [string] fileName: [string] sessionToken: A unique identifier for the webpage-upload session[int] fileSize: [string] uploadToken: A unique identifier for the HTML-file upload session[int] contentId: A unique identifier for the Content instance associated with the file being uploaded. This value is 0 while the upload session is in-progress.[string] sessionToken: A unique identifier for the webpage-upload session. This value is identical for all WebPageAsset instances in the array, as well as the parent HTML file.[string] fileName: The name of the asset file[string] uploadToken: A unique identifier for the asset-file upload session
[int] contentId: A unique identifier for the Content instance asociated with the HTML file. This [string] sha1Hash: The SHA1 hash value of the file contents[string] state: The current state of the HTML-file upload session. This value defaults to "started" in the POST response.[string] startTime: A UTC timestamp indicating when the content upload session began. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.[string] endTime: A UTC timestamp indicating when the content upload session ended. This value defaults null in the POST response.[string] lastActivityTime: A UTC timestamp indicating the last activity relating to the content upload session. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.[Chunk[]]chunks: An array of Chunk object instances representing sequential chunks of the HTML file. Each Chunk instance can have the following entries:[int] count: The order of the chunk in the sequence[int] length: The length (in bytes) of the chunk[string] state: The upload 6545163 of the chunk.
[WebPageAsset[]]assets: An array of WebPageAsset object instances representing asset files to upload as part of the webpage. Each WebPageAsset instance can have the following entries:[] fileSize: asset [string] sha1Hash: The [string] state: The assetqueued in [string] startTime: A This value defaults null in the POST response.[string] endTime: A This defaults in the POST response[string] lastActivityTime: A . This value defaults null in the POST response.[Chunk[]]chunks: [] count number chunks with the specified length and state. A zero value is used for the section of the file that has not been uploaded/queued yet.[int] length: The byte length of the chunk(s)[string] state: The upload 6545163 of the chunk(s)[int] count: The number of chunks with the specifiedlengthandstate. A zero value is used for the section of the file that has not been uploaded/queued yet.[int] length: The byte length of the chunk(s)[string] state: The upload 6545163 of the chunk(s)
Request Bobdy
[string] name: The name [string] fileName: [] fileSize: [] relativePath: sessionTokenDELETEsessionTokenuploadsGETsessionsuploads: A : An : The maximum number of WebpageUploadStatus instances that can be contained in the response body.content.upload.status.pagedlist.201701+json, application/vnd.bsn.error+json Response Body
[int] totalItemCount: [int] pageSize: The [] isTruncated: [] nextMarker: [] sortExpression: [] filterExpression: []items[] sessionToken[string] fileName HTML or asset [] uploadToken[] contentId asociated [] fileSize the [] sha1Hash[] state6545163 asset-[] startTime[] endTime[] lastActivityTime[]chunks An sessionTokenuploadsPOSTsessionsuploadssessionTokenuploadsuploadTokenGETsessionsuploadsuploadToken part of a webpage-upload session).Headers
Accept: application/vnd.bsn.content.upload.status.201701+json
Response Body
[string] sessionToken: [] fileName: [] uploadToken: [] contentId: asociated [] fileSize: [string] sha1Hash: The [string] state: The current 6545163[string] startTime: A [string] endTime: A [string] lastActivityTime: A []chunks: [] count[] length[] state upload 6545163sessionTokenuploadsuploadTokenPUTsessionsuploadsuploadToken applicationjson +json, application/vnd.bsn.content.upload.negotiation.status.201701+json, application/vnd.bsn.error+jsonRequest Body
[string] fileName: [] fileSize: [] relativePath: sessionTokenuploadsuploadTokenDELETEsessionsuploadsuploadTokensessionTokenuploadsuploadTokenchunksGET the file specified file upload.Headers
Accept: application/vnd.bsn.upload.content.chunk.status.list.201701+json
Response Body
[Chunk[]]chunks: [] count[] length[] state upload 6545163sessionTokenuploadsuploadTokenchunksPOST reccomend Parameters: