Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 28 Current »

This endpoint allows for management of content files (and content tags) on the network. 

Base URL for these endpoints:  https://api.brightsignnetwork.com/2017/01/REST/Content

GET  /

Retrieves a list of content files on the network.

Parameters

filter  string

An expression for filtering search results


sort string

An expression for sorting the search results. The sort expression specifies the entry used for sorting and the ascending/descending (ASC/DESC) sorting order (e.g. "[Content].[FileName] ASC")


marker string

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of content instances exceeds the pageSize.


pageSize int

The maximum number of content instances that can be contained in the response body

______________________________________________________________

Response Body

Returns a paged list of every Content Entity on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

DELETE  /

Removes content files, specified by a filter, from a network. This allows multiple content files to be deleted at once.

Parameters

filter string 

An expression for filtering search results

______________________________________________________________

Response Body

Returns the number of affected content files as an integer value.


GET /Root/{*virtualPath}/ 

Retrieves a list of content files in the specified virtual-directory folder.

Parameters

virtualPath string

The location of the content instance in the BSN.cloud virtual directory


sort string

An expression for sorting the search results. The sort expression specifies the entry used for sorting and the ascending/descending (ASC/DESC) sorting order (e.g. "[Content].[FileName] ASC")


marker string 

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of content instances exceeds the pageSize.


pageSize int 

The maximum number of content instances that can be contained in the response body

______________________________________________________________

Response Body

Returns a paged list of Content Folder entities on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

POST /Root/{*virtualPath}/ 

Creates a content folder in the specified virtual directory folder and returns the URL link to the folder location. This resource maps to the virtual folder in the content library, accordingly the virtual path is either complete or a partial path to a destination content folder or file.

Parameters

virtualPath string

The location of the content instance in the BSN.cloud virtual directory

______________________________________________________________

Request Body

The Content Folder Entity entity

______________________________________________________________

Response Body

Returns a 201 status code and the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the Content Folder Entity.

Endpoints:


GET  /Count/ 

Retrieves the number of content files on the network matching the specified filter criteria. If no filter is included, this call returns the total number of content files on the network. 

Parameters

filter string

An expression for filtering search results

______________________________________________________________

Response Body

The content file count is returned as an integer value.


GET /Operations/ 

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

GET /{id:int}/ 

Retrieves the specified content files on a network. 

Parameters

id int

A unique identifier for the content instance. This value is generated by the server when the content file is uploaded.


maxWidth  uShort

The maximum width of the content instance (this should equal 100)


maxHeight uShort

The maximum height of the content instance (this should equal 100)

______________________________________________________________

Response Body

The server returns code 200 upon success. Upon failure, it returns code 400 with an error message.


PUT /{id:int}/ 

Update the specified content files. 

Parameters

id int 

A unique identifier for the content instance. This value is generated by the server when the content file is uploaded.

______________________________________________________________

Request Body

The Content Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE /{id:int}/ 

Removes the specified content file. 

Parameters

id int

A unique identifier for the content instance. This value is generated by the server when the content file is uploaded.

______________________________________________________________

Response Body

The server returns code 200 upon success. Upon failure, it returns code 400 with an error message.

GET  /{id:int}/Tags/ 

Returns tags associated with the specified content file.

Parameters

id int 

A unique identifier for the content instance. This value is generated by the server when the content file is uploaded.

______________________________________________________________

Response Body

Returns an array of key/value pairs that represent tags assigned to the content file. Each tag is formatted as follows: 

"<value_type>::<tag_type>.<tag_key>":"<value>"

POST  /{id:int}/Tags/ 

Adds one or more tags to the specified content file.

Parameters

id  int

A unique identifier for the content instance. This value is generated by the server when the content file is uploaded.

______________________________________________________________

Request Body

The request body should contain an array of key/value pairs that specify tags to assign to the content file. Each tag must be formatted as follows: "<value_type>::<tag_type>.<tag_key>":"<value>"

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE  /{id:int}/Tags/ 

Removes one or more tags from the specified content file.

Parameters

id int 

A unique identifier for the content instance. This value is generated by the server when the content file is uploaded.

______________________________________________________________

Request Body

The request body should contain an array of strings specifying tags to delete. Each string must be formatted as follows: "<value_type>::<tag_type>.<tag_key>"

Note

The following are valid system-defined values for content tags: "FileName", "FileSize", "ContentType", "UploadDate",  

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.


GET  /{id:int}/Permissions/ 

Includes object permissions for a given content instance.

Parameters

id int

A unique identifier for the content instance. This value is generated by the server when the content file is uploaded.

______________________________________________________________

Response Body

Returns the permissions property value of the Content Entity as a paged list of content entities.


POST  /{id:int}/Permissions/ 

Adds permissions to the specified content instance

Parameters

id int

A unique identifier for the content instance. This value is generated by the server when the content file is uploaded.

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.


DELETE  /{id:int}/Permissions/ 

Removes permissions from the specified content instance

Parameters

id int

A unique identifier for the content instance. This value is generated by the server when the content instance is uploaded.

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.






  • No labels