Api session event editor geolink set matching: 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
|(GEO_LINK Integer ID or multiple values in array [1, 2, 3])
| (GEO_LINK Integer ID or multiple values in array [1, 2, 3])
|Custom[[Geo Link]] IDs
| Custom[[Geo Link]] IDs
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
|[[Attribute]] Names
| [[Attribute]] Names
|
|  
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(String or multiple values in array ["a", "b", "c"] or matrix [["a", "b"], ["c", "d"], ["e", "f"]])
| (String or multiple values in array ["a", "b", "c"] or matrix [["a", "b"], ["c", "d"], ["e", "f"]])
|[[Attribute]] Values
| [[Attribute]] Values
|
|  
|-
|-
|3
| 3
|OPTIONAL
| OPTIONAL
|(SOURCE Integer ID)
| (SOURCE Integer ID)
|[[Source]] (optional)
| [[Source]] (optional)
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 39: Line 39:
!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/editorgeolink/set_matching/

Description: Match incoming features against this Attribute name and value.

Name Importance Type Description Values
0 REQUIRED (GEO_LINK Integer ID or multiple values in array [1, 2, 3]) CustomGeo Link IDs
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Attribute Names
2 REQUIRED (String or multiple values in array ["a", "b", "c"] or matrix [["a", "b"], ["c", "d"], ["e", "f"]]) Attribute Values
3 OPTIONAL (SOURCE Integer ID) Source (optional)

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/editorgeolink/set_matching/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute Name 1", [ "A1", "B1" ] ]'

Curl example multi item POST:

curl 'https://engine.tygron.com/api/session/event/editorgeolink/set_matching/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Attribute Name 1", "Attribute Name 2", "Attribute Name 3" ], [ [ "A1", "B1" ], [ "A2", "B2" ], [ "A3", "B3" ] ] ]'

JavaScript example POST:

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