Api session event editor measure add event

From Tygron Support wiki
Jump to navigation Jump to search

API Endpoint: editormeasure/add_event.

Description: Add a new event to a Measure for a specific Action Type.

Name Importance Type Description Values
0 REQUIRED (MEASURE Integer ID or multiple values in array [1, 2, 3]) Measure ID
1 REQUIRED (Boolean or multiple values in array [true, false, true]) Server Side (false = Client Side)
2 REQUIRED (ActionType or multiple values in array [a, b, c]) Action Type

Response Codes

Response Code: Description
200 Integer[] (Coded Event ID)
300-600 Codes Overview

Example POST

Curl example POST:

curl 'https://engine.tygron.com/api/session/event/editormeasure/add_event/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, true, "CONSTRUCTION_PLAN" ]'

Curl example multi item POST:

curl 'https://engine.tygron.com/api/session/event/editormeasure/add_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" ] ]'

JavaScript example POST:

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