Api session event editor parametric set function: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Set [[Function]]
API Endpoint: api/session/event/editorparametric/set_function/
 
Description: Set [[Function]]
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(PARAMETRIC_DESIGN Integer ID or multiple values in array [1, 2, 3])
| (PARAMETRIC_DESIGN Integer ID or multiple integer values in array [1, 2, 3])
|[[Parametric Design]]
| [[Parametric Design]]s
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(FunctionType or multiple values in array [a, b, c])
| (FunctionType or multiple values in array [a, b, c])
|[[Function]]Type[]
| [[Function]]Type[]
|
|  
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(Integer number or multiple values in array [1, 2, 3])
| (Integer number or multiple integer values in array [1, 2, 3])
|Integer[]
| Integer[]
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 30: Line 33:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorparametric/set_function/?f=JSON&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorparametric/set_function/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "ROAD", 1 ]'
with content:
</syntaxhighlight>
<pre>[ [ 1, 2, 3 ], [ "WATER", "GARDEN", "ROAD" ], [ 1, 2, 3 ] ]
Curl example multi item POST
</pre>
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorparametric/set_function/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "ROAD", "WATER", "PARKING" ], [ 1, 2, 3 ] ]'
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "ROAD", 1 ]'
};
fetch("https://engine.tygron.com/api/session/event/editorparametric/set_function/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor parametric]]
{{article end|seealso=*[[Api session event editor parametric]]
*[[Api session items parametricdesigns]]
*[[Api session items parametricdesigns]]

Latest revision as of 12:23, 17 June 2026

API Endpoint: api/session/event/editorparametric/set_function/

Description: Set Function

Index Importance Type Description Values
0 REQUIRED (PARAMETRIC_DESIGN Integer ID or multiple integer values in array [1, 2, 3]) Parametric Designs
1 REQUIRED (FunctionType or multiple values in array [a, b, c]) FunctionType[]
2 REQUIRED (Integer number or multiple integer values in array [1, 2, 3]) Integer[]

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

Curl example multi item POST 

curl 'https://engine.tygron.com/api/session/event/editorparametric/set_function/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "ROAD", "WATER", "PARKING" ], [ 1, 2, 3 ] ]'

JavaScript example POST 

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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_parametric_set_function&oldid=86858"