Api event share add: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Server@tygron.com (talk | contribs)
Created page with "API Endpoint: api/event/share/add/ Description: Add new Shareable for given path, name and type; returns a unique path with primary extension. For files larger than 2GB, use the Stream API. {|class=wikitable !Index !Importance !Type !Description !Values |- | 0 | REQUIRED | (String) | Path (e.g. "mydir/myname.tiff", note: viewers and directories end with a slash e.g. "mydir/viewer/") | |- | 1 | REQUIRED | (Enumeration) | Type | CITYGML, CITYJSON, CSV, DIRECTORY, DOC, D..."
 
Server@tygron.com (talk | contribs)
No edit summary
Line 40: Line 40:
|}
|}
===Example POST===
===Example POST===
Curl example POST
<syntaxhighlight lang="text" copy>curl 'https://devshare.tygron.com/api/event/share/add/' -H 'Content-Type: application/json' -H 'Authorization: Basic <credentials>=' -d '[ "Path", "GEOTIFF" ]'
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Basic <credentials>=" },
 body: '[ "Path", "GEOTIFF" ]'
};
fetch("https://devshare.tygron.com/api/event/share/add/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api event share]]
{{article end|seealso=*[[Api event share]]
}}
}}


[[Category:API]]
[[Category:API]]

Revision as of 15:11, 20 November 2026

API Endpoint: api/event/share/add/

Description: Add new Shareable for given path, name and type; returns a unique path with primary extension. For files larger than 2GB, use the Stream API.

Index Importance Type Description Values
0 REQUIRED (String) Path (e.g. "mydir/myname.tiff", note: viewers and directories end with a slash e.g. "mydir/viewer/")
1 REQUIRED (Enumeration) Type CITYGML, CITYJSON, CSV, DIRECTORY, DOC, DXF, EXCEL, GEOJSON, GEOPACKAGE, GEOTIFF, GIF, IFC, JPEG, MARKDOWN, ONNX, PDF, PNG, SLIDES, SLPK, TXT, VIEWER or ZIP
2 OPTIONAL (byte or multiple values in array [a, b, c]) Content Bytes (< 2GB) (optional)

Response Codes

Response Code: Description
200 String (String)
300-600 Codes Overview

Example POST

See also