Content Endpoints (2017/01)

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 filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm 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 entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of every content entity (2017/01) docid\ vdracvurh3z oipb6curv 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 filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm 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 entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of content folder entity (2017/01) docid\ r5gmltgblzsb0litulu7f 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 (2017/01) docid\ r5gmltgblzsb0litulu7f 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 (2017/01) docid\ r5gmltgblzsb0litulu7f 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 filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm 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 (2017/01) docid\ fwdujpp aohpf3res sz 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 (2017/01) docid\ vdracvurh3z oipb6curv 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>" 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 (2017/01) docid\ vdracvurh3z oipb6curv 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 (2017/01) docid\ horbsqti93 eafzzftgmy 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 (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx