B-Deploy Setup Endpoints (v3)

these endpoints allow users to automatically provision brightsign players over the internet this endpoint handles everything regarding individual players add your serial number to brightsign’s cloud storage with an associated player name, provisioning package name, and the url where the provisioning package is hosted the url is optional it can be left blank if using a setup package version 3 0 of these apis contains additional support for multiple network interfaces through the network entity (v3) docid\ q84emt6m9ggaj8smutpq7 object base url for these endpoints https //provision bsn cloud/rest setup/v3/setup/ get / returns a list of setup records in the exact format they are stored in the b deploy database the main setup values are stored in each array object in the “setupjson” parameter if you want to get information about a specific b deploy setup, see b deploy setup endpoints (v3) docid\ aqq49ls5eyge5ou gewpu query string parameter networkname string string required required the user defined name of the bsn cloud network username string string optional optional the name of the user who created the setup package packagename string string optional optional the user defined name of the setup package example request curl location 	 \ request get 'https //provision bsn cloud/rest setup/v3/setup?networkname=anon\&username=testuser\@email com' \\ 	 \ header 'authorization bearer {{token}}' success response body 200 200 returns an array of the following information for each setup in the network id string string the system supplied id of the device setup updatedat string string a utc timestamp indicating when the device setup was last modified createdat string string a utc timestamp indicating when the device setup was created username string string the bsn cloud username client string string the client id of the bsn cloud server packagename string string the client defined name for the device setup package this value must be unique among device setup packages that belong to your person entity setuptype string string the device setup type (either "lfn", "sfn", "partner", "standalone", or "bsn") version string string the b deploy cloud version this value should be "3 0 0" networkname string string the bsn cloud network name devicename string string the user defined device name devicedescription string string the user defined device description bsngroupname string string the bsn cloud group name setupjson devicesetup\[] devicesetup\[] a device setup entity (v3) docid\ rhtiqljdtc jzorvpnv8 , https //brightsign atlassian net/wiki/spaces/doc/pages/1425670145/device+setup+entity+v3 which contains all of the setup parameters in stringified json failure response 400 400 the request is malformed and therefore invalid (for example, networkname is not specified) 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method the access token used to call this /v3/setup api must belong to the same network 5xx 5xx any 500 code is an internal server error post / adds device setups to the b deploy server request body the device setup entity (v3) docid\ rhtiqljdtc jzorvpnv8 example request curl location 	 \ request post 'https //provision bsn cloud/rest setup/v3/setup?query%5bnetworkname%5d=test' \\ 	 \ header 'content type application/json' \\ 	 \ header 'authorization bearer {{token}}'\\ 	 \ data raw '{exampledevicesetupobject}' note that the data raw flag allows a request body to be passed and exampledevicesetupobject is a placeholder for a device setup object success response body 201 201 the id of the device setup object failure response 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 415 415 the server cannot accept the data representation that you sent (as specified in the header) 5xx 5xx any 500 code is an internal server error put / updates existing device setups on the b deploy server request body devicesetup object object a device setup entity (v3) docid\ rhtiqljdtc jzorvpnv8 example request curl location 	 \ request put 'https //provision bsn cloud/rest setup/v3/setup?username=example\@gmail com' \\ 	 \ header 'content type application/json' \\ 	 \ header 'authorization bearer {{token}}'\\ 	 \ data raw '{exampledevicesetupobject}' the data raw flag allows a request body to be passed and exampledevicesetupobject is a placeholder for a device setup object success response 200 200 the existing device setup has been updated failure response 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 415 415 the server cannot accept the data representation that you sent (as specified in the header) 5xx 5xx any 500 code is an internal server error delete / deletes a device setup from the b deploy server query string parameter id string string required required the id of the device setup to delete example request curl location 	 \ request delete 'https //provision bsn cloud/rest setup/v3/setup/618fb7363a682fe7a40c73ca' \\ 	 \ header 'authorization bearer {{token}}' success response 200 200 the specified device setup has been removed failure response 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 5xx 5xx any 500 code is an internal server error get / id/ retrieves the device setup from the b deploy server for one specified setup id route parameter id string string required required the database id of the device setup you want to retrieve this "id" is returned in the response to /rest setup/v3/setup/post , above example request curl location 	 \ request get 'https //provision bsn cloud/rest setup/v3/setup/618fb7363a682fe7a40c73ca' \\ 	 \ header 'authorization bearer {{token}}' success response body 200 200 returns an empty array of device setup errors and the device setup entity (v3) docid\ rhtiqljdtc jzorvpnv8 failure response 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method the access token used to call this /v3/setup api must belong to the same network 5xx 5xx any 500 code is an internal server error