Api session event logic measurement set overlays: 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/logic/measurement_set_overlays/
API Endpoint: api/session/event/logic/measurement_set_overlays/


Description: Set base [[Overlay]]s for an existing [[Measurement]].
Description: Set base [[Overlay]]s for a [[Measurement]].


{|class=wikitable
{|class=wikitable
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (MEASUREMENT Integer ID)
| (MEASUREMENT Integer ID)
| [[Measurement]] ID
| [[Measurement]]
|  
|  
|-
|-
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (OVERLAY Integer ID or multiple integer values in array [1, 2, 3])
| (OVERLAY Integer ID or multiple integer values in array [1, 2, 3])
| [[Overlay]] ID
| [[Overlay]]s
|  
|  
|}
|}

Revision as of 15:33, 10 November 2026

API Endpoint: api/session/event/logic/measurement_set_overlays/

Description: Set base Overlays for a Measurement.

Index Importance Type Description Values
0 REQUIRED (MEASUREMENT Integer ID) Measurement
1 REQUIRED (OVERLAY Integer ID or multiple integer values in array [1, 2, 3]) Overlays

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/logic/measurement_set_overlays/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1 ]'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/logic/measurement_set_overlays/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, [ 1, 2, 3 ] ]'

JavaScript example POST

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