Api session event editor building query: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API | API Endpoint: api/session/event/editorbuilding/query/ | ||
Description: Execute a single [[Tygron Query Language|TQL Query]]. Use the [[Session]]/query endpoint for multiple statements or detailed API usage information. | |||
{|class=wikitable | {|class=wikitable | ||
! | !Index | ||
!Importance | !Importance | ||
!Type | !Type | ||
| Line 7: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(String) | | (String) | ||
|[[Tygron Query Language|TQL Query]] Statement | | [[Tygron Query Language|TQL Query]] Statement | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|OPTIONAL | | OPTIONAL | ||
|(Floating point number or multiple values in array [1.0, 2.0, 3.0]) | | (Floating point number or multiple values in array [1.0, 2.0, 3.0]) | ||
|Value for update queries (optional) | | Value for update queries (optional) | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 24: | Line 27: | ||
!Description | !Description | ||
|- | |- | ||
|200 | | 200 | ||
|Object (Object) | | Object (Object) | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Curl | Curl example POST | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/query/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '"TQL Query Statement"' | |||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/query/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d ' | |||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript | JavaScript example POST | ||
<syntaxhighlight lang="text" copy>var options = { | <syntaxhighlight lang="text" copy>var options = { | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: ' | body: '"TQL Query Statement"' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/editorbuilding/query/", options) | fetch("https://engine.tygron.com/api/session/event/editorbuilding/query/", options) | ||
Latest revision as of 09:58, 13 July 2026
API Endpoint: api/session/event/editorbuilding/query/
Description: Execute a single TQL Query. Use the Session/query endpoint for multiple statements or detailed API usage information.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (String) | TQL Query Statement | |
| 1 | OPTIONAL | (Floating point number or multiple values in array [1.0, 2.0, 3.0]) | Value for update queries (optional) |
Response Codes
| Response Code: | Description |
|---|---|
| 200 | Object (Object) |
| 300-600 | Codes Overview |
Example POST
Curl example POST
curl 'https://engine.tygron.com/api/session/event/editorbuilding/query/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '"TQL Query Statement"'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '"TQL Query Statement"'
};
fetch("https://engine.tygron.com/api/session/event/editorbuilding/query/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));