Api session event editor activate testrun: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Start or stop a [[Scenario]] Testrun.
API Endpoint: api/session/event/editor/activate_testrun/
 
Description: Start or stop a [[Scenario]] Testrun.
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(true, false)
| (true, false)
|Start the [[Scenario]] Testrun (false means stop)
| True to start the [[Scenario]] Testrun, false to stop.
|true  or  false
| true  or  false
|}
|}
===Response Codes===
===Response Codes===
Line 18: Line 21:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Curl Example POST:
Curl example POST
<syntaxhighlight lang="text" copy>curl
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editor/activate_testrun/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d 'true'
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: 'true'
};
fetch("https://engine.tygron.com/api/session/event/editor/activate_testrun/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor]]
{{article end|seealso=*[[Api session event editor]]
}}
}}


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

Latest revision as of 09:57, 13 July 2026

API Endpoint: api/session/event/editor/activate_testrun/

Description: Start or stop a Scenario Testrun.

Index Importance Type Description Values
0 REQUIRED (true, false) True to start the Scenario Testrun, false to stop. true or false

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/editor/activate_testrun/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d 'true'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: 'true'
};
fetch("https://engine.tygron.com/api/session/event/editor/activate_testrun/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));