Api session event editor measure set event: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
API Endpoint: api/session/event/editormeasure/set_event/
API Endpoint: api/session/event/editormeasure/set_event/


Description: Change an existing event of a specific [[Action]] Type of a [[Measure]].
Description: Change an pre-existing event of a specific [[Action]] Type of a [[Measure]].


{|class=wikitable
{|class=wikitable
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (MEASURE Integer ID or multiple integer values in array [1, 2, 3])
| (MEASURE Integer ID or multiple integer values in array [1, 2, 3])
| [[Measure]] ID
| [[Measure]]s
|  
|  
|-
|-
Line 25: Line 25:
| REQUIRED
| REQUIRED
| (ActionType or multiple values in array [a, b, c])
| (ActionType or multiple values in array [a, b, c])
| [[Action]] Type
| [[Action]] Types
|  
|  
|-
|-
Line 31: Line 31:
| REQUIRED
| REQUIRED
| (CodedEvent or multiple values in array [a, b, c])
| (CodedEvent or multiple values in array [a, b, c])
| CodedEvent contents
| CodedEvents
|  
|  
|}
|}

Revision as of 15:30, 10 November 2026

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

Description: Change an pre-existing event of a specific Action Type of a Measure.

Index Importance Type Description Values
0 REQUIRED (MEASURE Integer ID or multiple integer values in array [1, 2, 3]) Measures
1 REQUIRED (Boolean or multiple boolean values in array [true, false, true]) Server Side (false = Client Side)
2 REQUIRED (ActionType or multiple values in array [a, b, c]) Action Types
3 REQUIRED (CodedEvent or multiple values in array [a, b, c]) CodedEvents

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

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editormeasure/set_event/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ 1, 2, 3 ], [ true, false, true ], [ "CONSTRUCTION_PLAN", "CONSTRUCTION_PLAN_CANCEL", "CONSTRUCTION_PLAN_CANCEL" ], [ {
 "id" : -1,
 "parameters" : [ ]
}, {
 "id" : -1,
 "parameters" : [ ]
}, {
 "id" : -1,
 "parameters" : [ ]
} ] ]
'

JavaScript example POST

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