Api event share set description
API Endpoint: api/event/share/set_description/
Description: Set description for given path.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | Path (e.g. "mydir/myname.tiff", note: viewers and directories end with a slash e.g. "mydir/viewer/") | |
| 1 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | Description text |
Response Codes
| Response Code: | Description |
|---|---|
| 200 | Boolean (Content was updated) |
| 300-600 | Codes Overview |
Example POST
Curl example POST
curl 'https://devshare.tygron.com/api/event/share/set_description/' -H 'Content-Type: application/json' -H 'Authorization: Basic <credentials>=' -d '[ "Path 1", "Description text 1" ]'Curl example multi item POST
curl 'https://devshare.tygron.com/api/event/share/set_description/' -H 'Content-Type: application/json' -H 'Authorization: Basic <credentials>=' -d '[ [ "Path 1", "Path 2", "Path 3" ], [ "Description text 1", "Description text 2", "Description text 3" ] ]'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Basic <credentials>=" },
body: '[ "Path 1", "Description text 1" ]'
};
fetch("https://devshare.tygron.com/api/event/share/set_description/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));