{"info":{"_postman_id":"e3f465a1-e3df-4922-8d0c-c23d43e1b21d","name":"Webstorage REST API Documentation","description":"

Introduction

REST API to read and write webstorage variable on the HMP.

Overview

The following are supported:

List all existing variables
Get a variable
Set a varibale

Additionally it is possible the set variables using a POST request on the base end point.

Notes:

Both HTTP and HTTPS are supported

Authentication

Access to the API end-point must be enabled on Control Center in the Advanced Apllication -> Webstorage API page.
A Bearer Authorization header or an access_token query string parameter is needed to access the API end-points.

Notes:

HTTP basic authentication is supported using the credentials of users defined in Control Center (user must at least have content editing role)
TLS-SRP authentication is supported using the credentials of users defined in Control Center (user must at least have content editing role)
Using http is not secure, any eavesdropper can steal the bearer token or user password.
Using https, either with self-signed certificate or with TLS-SRP is a secure alternative

Example using Bearer

var settings = {\n  \"url\": \"http://{{hmp-address}}/webstorage\",\n  \"method\": \"GET\",\n  \"headers\": {\n    \"Authorization\": \"Bearer {{Security Token}}\"\n  }\n}\n\n$.ajax(settings).done(function (response) {\n  console.log(response);\n});\n

Example using query string

var settings = {\n  \"url\": \"http://{{hmp-address}}/webstorage??access_token={{Security Token}}\",\n  \"method\": \"GET\"\n}\n\n$.ajax(settings).done(function (response) {\n  console.log(response);\n});\n

End-points

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"End-points","slug":"end-points"}],"owner":"429090","collectionId":"e3f465a1-e3df-4922-8d0c-c23d43e1b21d","publishedId":"RWEZRNPh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-07-06T16:25:31.000Z"},"item":[{"name":"List variables","event":[{"listen":"test","script":{"id":"1dda6da9-bafe-4b2a-bee9-611fba10533b","type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","var responseJSON;","try {"," responseJSON = JSON.parse(responseBody);"," tests[\"Body is a list\"] = Array.isArray( responseJSON );"," tests[\"test do not exist\"] = responseJSON.indexOf(\"test\") === -1;","}","catch (e) { }"]}}],"id":"6d7bc93e-d0a6-4a51-8a6a-51a554676603","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{webstorage-security-token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"325432"},"url":"http://{{hmp-address}}/webstorage","description":"

Get the list of webstorage variable on the player

\n","urlObject":{"protocol":"http","path":["webstorage"],"host":["{{hmp-address}}"],"query":[],"variable":[]}},"response":[{"id":"7c970389-c6d1-4a2f-a585-09a901b49b85","name":"List variables","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"325432"},"url":"http://{{spx-hmp-serial}}/webstorage"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"25","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 10:10:05 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"[\n \"variable1\",\n \"variable2\",\n \"variable3\"\n]"}],"_postman_id":"6d7bc93e-d0a6-4a51-8a6a-51a554676603"},{"name":"Update variable","event":[{"listen":"test","script":{"id":"f49e4d85-ffed-4c90-b79b-96a5573b5fe2","type":"text/javascript","exec":["tests[\"Status code is 204\"] = responseCode.code === 204;",""]}}],"id":"917ddaca-88c2-4740-81fc-088b7736387e","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{webstorage-security-token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"test string"},"url":"http://{{hmp-address}}/webstorage/{{name}}","description":"

Update the variable {{name}} with the content of the POST

\n","urlObject":{"protocol":"http","path":["webstorage","{{name}}"],"host":["{{hmp-address}}"],"query":[],"variable":[]}},"response":[{"id":"2191d6ab-6996-4e13-9feb-78e5c640dade","name":"Update","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"{{value}}"},"url":"http://{{spx-hmp-serial}}/webstorage/{{name}}"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:23:15 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":" "},{"id":"2ee42932-a96f-40bc-a777-a1a86976c4f6","name":"Create","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"{{value}}"},"url":"http://{{spx-hmp-serial}}/webstorage/{{name}}"},"status":"Created","code":201,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:22:31 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":" "}],"_postman_id":"917ddaca-88c2-4740-81fc-088b7736387e"},{"name":"Update variable with a condition","event":[{"listen":"test","script":{"id":"ee5d93b4-237e-4c0c-9f98-fb97bb2316c7","type":"text/javascript","exec":["tests[\"Status code is 204\"] = responseCode.code === 204;",""]}}],"id":"f6bdccc1-97ca-4c12-a0ef-623e4520ac46","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{webstorage-security-token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"new string"},"url":"http://{{hmp-address}}/webstorage/{{name}}?expect={{value}}","description":"

Update the variable {{name}} with the content of the POST only is the previous value of the variable is equal to {{value}}

\n","urlObject":{"protocol":"http","path":["webstorage","{{name}}"],"host":["{{hmp-address}}"],"query":[{"description":{"content":"

Previous value of the variable {{name}}

\n","type":"text/plain"},"key":"expect","value":"{{value}}"}],"variable":[]}},"response":[{"id":"48a1df86-1a8e-4be9-a17a-dec75bd38ead","name":"Condition valid","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"new string"},"url":{"raw":"http://{{spx-hmp-serial}}/webstorage/{{name}}?expect={{value}}","protocol":"http","host":["{{spx-hmp-serial}}"],"path":["webstorage","{{name}}"],"query":[{"key":"expect","value":"{{value}}","description":"Previous value of the variable {{name}}"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:17:01 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"\n"},{"id":"4c2d4c88-35d2-47f5-b36e-fc40d72052a8","name":"Condition not valid","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"new string"},"url":{"raw":"http://{{spx-hmp-serial}}/webstorage/{{name}}?expect={{value}}","protocol":"http","host":["{{spx-hmp-serial}}"],"path":["webstorage","{{name}}"],"query":[{"key":"expect","value":"{{value}}","description":"Previous value of the variable {{name}}"}]}},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:27:59 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"\n"},{"id":"f11a3495-b4f6-4ecb-aadc-9a9469c53868","name":"Variable do not exist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"new string"},"url":{"raw":"http://{{spx-hmp-serial}}/webstorage/{{name}}?expect={{value}}","protocol":"http","host":["{{spx-hmp-serial}}"],"path":["webstorage","{{name}}"],"query":[{"key":"expect","value":"{{value}}","description":"Previous value of the variable {{name}}"}]}},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:26:58 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"\n"}],"_postman_id":"f6bdccc1-97ca-4c12-a0ef-623e4520ac46"},{"name":"Update variable","event":[{"listen":"test","script":{"id":"f49e4d85-ffed-4c90-b79b-96a5573b5fe2","exec":["tests[\"Status code is 204\"] = responseCode.code === 204;",""],"type":"text/javascript"}}],"id":"411d670c-2c14-4c78-abbe-e86cf7641655","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{webstorage-security-token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"test string"},"url":"http://{{hmp-address}}/webstorage/{{name}}","description":"

Update the variable {{name}} with the content of the PUT

\n","urlObject":{"protocol":"http","path":["webstorage","{{name}}"],"host":["{{hmp-address}}"],"query":[],"variable":[]}},"response":[{"id":"55074bab-fd15-4dfc-9f99-37c2abc46d9b","name":"Create","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"{{value}}"},"url":"http://{{spx-hmp-serial}}/webstorage/{{name}}"},"status":"Created","code":201,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:22:31 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":" "},{"id":"88dab425-106e-4fd3-ad50-922d63df8f7d","name":"Update","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"{{value}}"},"url":"http://{{spx-hmp-serial}}/webstorage/{{name}}"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:23:15 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":" "}],"_postman_id":"411d670c-2c14-4c78-abbe-e86cf7641655"},{"name":"Update variable with a condition","event":[{"listen":"test","script":{"id":"ee5d93b4-237e-4c0c-9f98-fb97bb2316c7","exec":["tests[\"Status code is 204\"] = responseCode.code === 204;",""],"type":"text/javascript"}}],"id":"7cc86afd-6ce5-4d66-9247-e50c93b545bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{webstorage-security-token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"new string"},"url":"http://{{hmp-address}}/webstorage/{{name}}?expect={{value}}","description":"

Update the variable {{name}} with the content of the PUT only is the previous value of the variable is equal to {{value}}

\n","urlObject":{"protocol":"http","path":["webstorage","{{name}}"],"host":["{{hmp-address}}"],"query":[{"description":{"content":"

Previous value of the variable {{name}}

\n","type":"text/plain"},"key":"expect","value":"{{value}}"}],"variable":[]}},"response":[{"id":"3a44a382-79e1-4f57-9148-458610d9ca60","name":"Condition not valid","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"new string"},"url":{"raw":"http://{{spx-hmp-serial}}/webstorage/{{name}}?expect={{value}}","protocol":"http","host":["{{spx-hmp-serial}}"],"path":["webstorage","{{name}}"],"query":[{"key":"expect","value":"{{value}}","description":"Previous value of the variable {{name}}"}]}},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:27:59 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"\n"},{"id":"3ebf94fe-7b71-495e-a914-439af07f3538","name":"Condition valid","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"new string"},"url":{"raw":"http://{{spx-hmp-serial}}/webstorage/{{name}}?expect={{value}}","protocol":"http","host":["{{spx-hmp-serial}}"],"path":["webstorage","{{name}}"],"query":[{"key":"expect","value":"{{value}}","description":"Previous value of the variable {{name}}"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:17:01 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"\n"},{"id":"e4500d06-1ee5-4251-a43d-b0a3b966a277","name":"Variable do not exist","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"new string"},"url":{"raw":"http://{{spx-hmp-serial}}/webstorage/{{name}}?expect={{value}}","protocol":"http","host":["{{spx-hmp-serial}}"],"path":["webstorage","{{name}}"],"query":[{"key":"expect","value":"{{value}}","description":"Previous value of the variable {{name}}"}]}},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:26:58 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"\n"}],"_postman_id":"7cc86afd-6ce5-4d66-9247-e50c93b545bc"},{"name":"Get value of variable (path)","event":[{"listen":"test","script":{"id":"21b2cb2a-b265-4e8f-b34a-b9d558fed684","type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","tests[\"response body is a string\"] = responseBody === \"test string\";",""]}}],"id":"70d9310b-919c-4213-a0b2-581e1fc005bf","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{webstorage-security-token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"test string"},"url":"http://{{hmp-address}}/webstorage/{{name}}","description":"

Get the value of the variable {{name}}

\n","urlObject":{"protocol":"http","path":["webstorage","{{name}}"],"host":["{{hmp-address}}"],"query":[],"variable":[]}},"response":[{"id":"2c253b6f-c731-4f0d-a3f9-65a436a5cb5a","name":"Variable exist","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"test string"},"url":"http://{{spx-hmp-serial}}/webstorage/{{name}}"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:13:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Last-Modified","value":"Tue, 05 Jun 2018 11:12:27 GMT","name":"Last-Modified","description":"The last modified date for the requested object, in RFC 2822 format"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"test string"},{"id":"b80d4b7c-9de2-48ee-b054-ef53a66e7997","name":"Variable do not exist","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"test string"},"url":"http://{{spx-hmp-serial}}/webstorage/{{name}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"21","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:25:02 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"error\":\"Not found\"}"}],"_postman_id":"70d9310b-919c-4213-a0b2-581e1fc005bf"},{"name":"Get value of variable (query string)","event":[{"listen":"test","script":{"id":"0f71270e-1378-42c4-853c-29e2eea72959","type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","tests[\"response body is a string\"] = responseBody === \"test string\";",""]}}],"id":"2f13a445-e77f-469f-9e65-caf77e45b115","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{webstorage-security-token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"325432"},"url":"http://{{hmp-address}}/webstorage?name={{name}}","description":"

Get the value of the variable {{name}}

\n","urlObject":{"protocol":"http","path":["webstorage"],"host":["{{hmp-address}}"],"query":[{"description":{"content":"

Name of the variable

\n","type":"text/plain"},"key":"name","value":"{{name}}"}],"variable":[]}},"response":[{"id":"4a30494b-99a9-49b4-a185-8c4e3fff9376","name":"Variable exist","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"325432"},"url":{"raw":"http://{{spx-hmp-serial}}/webstorage?name={{name}}","protocol":"http","host":["{{spx-hmp-serial}}"],"path":["webstorage"],"query":[{"key":"name","value":"{{name}}","description":"Name of the variable"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:12:50 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Last-Modified","value":"Tue, 05 Jun 2018 11:12:27 GMT","name":"Last-Modified","description":"The last modified date for the requested object, in RFC 2822 format"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"test string"},{"id":"85338f3c-348e-4017-af73-375c50b8945f","name":"Variable do not exist","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"325432"},"url":{"raw":"http://{{spx-hmp-serial}}/webstorage?name={{name}}","protocol":"http","host":["{{spx-hmp-serial}}"],"path":["webstorage"],"query":[{"key":"name","value":"{{name}}","description":"Name of the variable"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"21","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:25:57 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"error\":\"Not found\"}"}],"_postman_id":"2f13a445-e77f-469f-9e65-caf77e45b115"},{"name":"Delete variable","event":[{"listen":"test","script":{"id":"b71bc1f4-f10d-49ec-b9d5-22fb0f7745d9","type":"text/javascript","exec":["tests[\"Status code is 204\"] = responseCode.code === 204;"]}}],"id":"d47a3b81-5058-446e-8919-9518c5c0e71d","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{webstorage-security-token}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"test string"},"url":"http://{{hmp-address}}/webstorage/{{name}}","description":"

Delete the variable {{name}}

\n","urlObject":{"protocol":"http","path":["webstorage","{{name}}"],"host":["{{hmp-address}}"],"query":[],"variable":[]}},"response":[{"id":"998dc7e5-8c46-4f5a-a763-ad4c4c3273b8","name":"Variable exist","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"test string"},"url":"http://{{spx-hmp-serial}}/webstorage/{{name}}"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:17:14 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":" "},{"id":"de13095f-6a4a-4066-b901-f1f5edab49c6","name":"Variable do not exist","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"raw","raw":"test string"},"url":"http://{{spx-hmp-serial}}/webstorage/{{name}}"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:30:04 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":" "}],"_postman_id":"d47a3b81-5058-446e-8919-9518c5c0e71d"},{"name":"Update variables using POST","event":[{"listen":"test","script":{"id":"7da1db52-6bdd-467d-8876-6f74128baa33","type":"text/javascript","exec":["tests[\"Status code is 204\"] = responseCode.code === 204;","",""]}}],"id":"c56f9245-5987-421b-a270-9be979db54d9","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{webstorage-security-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"test1","value":"some value","type":"text"}]},"url":"http://{{hmp-address}}/webstorage/","description":"

Update one of more variable using a form.

\n","urlObject":{"protocol":"http","path":["webstorage",""],"host":["{{hmp-address}}"],"query":[],"variable":[]}},"response":[{"id":"3cb1359a-c9ba-45bf-bcc7-3e7776e5a37a","name":"form-data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"test2","value":"test 2 value","type":"text"},{"key":"test3","value":"test 3 value","type":"text"}]},"url":"http://{{spx-hmp-serial}}/webstorage/"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:18:34 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":" "},{"id":"6324c228-1cb5-4e66-abc5-6e1cb6b20694","name":"x-www-form-encoded","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","name":"Content-Type","value":"application/x-www-form-urlencoded","disabled":false},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"test1","value":"some value","type":"text"}]},"url":"http://{{spx-hmp-serial}}/webstorage/"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:32:00 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":" "}],"_postman_id":"c56f9245-5987-421b-a270-9be979db54d9"},{"name":"Clear all variables","event":[{"listen":"test","script":{"id":"b71bc1f4-f10d-49ec-b9d5-22fb0f7745d9","exec":["tests[\"Status code is 204\"] = responseCode.code === 204;"],"type":"text/javascript"}}],"id":"8c8f7e6a-f6af-433b-8e28-73de1d681540","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PURGE","header":[],"body":{"mode":"raw","raw":""},"url":"http://{{spx-hmp-serial}}/webstorage","description":"

Remove all variables from the player

\n","urlObject":{"protocol":"http","path":["webstorage"],"host":["{{spx-hmp-serial}}"],"query":[],"variable":[]}},"response":[{"id":"d2d67880-a3d7-403d-91ef-80ba2b16b48a","name":"Delete all variables","originalRequest":{"method":"PURGE","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"Basic YWRtaW46YWRtaW4=","disabled":true}],"url":"http://{{spx-hmp-serial}}/webstorage"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 05 Jun 2018 11:17:14 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.6 (Unix)","name":"Server","description":"A name for the server"},{"key":"X-raperca-version","value":"4.3.0-033046","name":"X-raperca-version","description":"Custom header"},{"key":"X-spinetix-firmware","value":"4.3.0-1.0.33060","name":"X-spinetix-firmware","description":"Custom header"},{"key":"X-spinetix-hw","value":"ikebana-x","name":"X-spinetix-hw","description":"Custom header"},{"key":"X-spinetix-serial","value":"001d50200011","name":"X-spinetix-serial","description":"Custom header"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8c8f7e6a-f6af-433b-8e28-73de1d681540"}]}