Api session event editor eventbundle set event: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 10: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(EVENT_BUNDLE Integer ID)
| (EVENT_BUNDLE Integer ID)
|[[Event Bundle]]s
| [[Event Bundle]]s
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(true, false)
| (true, false)
|Boolean
| Boolean
|true  or  false
| true  or  false
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(CodedEvent)
| (CodedEvent)
|CodedEvent
| CodedEvent
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 33: Line 33:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===

Revision as of 11:38, 8 June 2026

API Endpoint: api/session/event/editoreventbundle/set_event/

Description: Set Event

Name Importance Type Description Values
0 REQUIRED (EVENT_BUNDLE Integer ID) Event Bundles
1 REQUIRED (true, false) Boolean true or false
2 REQUIRED (CodedEvent) CodedEvent

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/editoreventbundle/set_event/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, true, {
 "id" : -1,
 "parameters" : [ ]
} ]
'

JavaScript example POST:

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