Api session event editor parametric apply: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Event to Apply {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(PARAMETRIC_DESIGN Integer ID) |Parametric Designs | |- |1 |REQUIRED |(STAKEHOLDER Integer ID) |Stakeholders | |- |2 |REQUIRED |(FunctionType or multiple values in array [a, b, c]) |FunctionType[] | |- |3 |REQUIRED |(Integer number or multiple values in array [1, 2, 3]) |Integer[] | |- |4 |REQUIRED |(MultiPolygon or multiple values in array [a, b, c]) |MultiPoly..."
 
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 10: Line 10:
|REQUIRED
|REQUIRED
|(PARAMETRIC_DESIGN Integer ID)
|(PARAMETRIC_DESIGN Integer ID)
|[[Parametric Design]]s
|[[Parametric Design]]
|
|
|-
|-
Line 16: Line 16:
|REQUIRED
|REQUIRED
|(STAKEHOLDER Integer ID)
|(STAKEHOLDER Integer ID)
|[[Stakeholder]]s
|[[Stakeholder]]
|
|
|-
|-
Line 49: Line 49:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorparametric/apply/?f=HTML&token=API_TOKEN
Example POST: https://engine.tygron.com/api/session/event/editorparametric/apply/?f=JSON&token=API_TOKEN


with content:  
with content:  
<pre>[ 12, 6, [ "REMAINDER", "PUBLIC_GREEN", "GARDEN" ], [ 1, 2, 3 ], [ [ {
<pre>[ 10, 36, [ "BUILDING", "SIDEWALK", "GARDEN" ], [ 1, 2, 3 ], [ [ {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799374.930932248 ], [ 658718.0709767976, 6799374.930932248 ], [ 658718.0709767976, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799369.134454882 ], [ 658745.5042595589, 6799369.134454882 ], [ 658745.5042595589, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, {
}, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799391.945217045 ], [ 658704.6945919287, 6799391.945217045 ], [ 658704.6945919287, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799381.908148949 ], [ 658789.3039617377, 6799381.908148949 ], [ 658789.3039617377, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
} ], [ {
} ], [ {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799302.828506164 ], [ 658773.6846449232, 6799302.828506164 ], [ 658773.6846449232, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799337.1345314 ], [ 658700.9736961377, 6799337.1345314 ], [ 658700.9736961377, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, {
}, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799354.561261838 ], [ 658767.9985444586, 6799354.561261838 ], [ 658767.9985444586, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799421.17784276 ], [ 658772.557494474, 6799421.17784276 ], [ 658772.557494474, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
} ], [ {
} ], [ {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799423.529580336 ], [ 658731.869637051, 6799423.529580336 ], [ 658731.869637051, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799430.268091854 ], [ 658687.9659901621, 6799430.268091854 ], [ 658687.9659901621, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, {
}, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799408.530768496 ], [ 658725.7596370659, 6799408.530768496 ], [ 658725.7596370659, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799382.614641199 ], [ 658681.0780289881, 6799382.614641199 ], [ 658681.0780289881, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
} ] ] ]
} ] ] ]
</pre>
</pre>
{{article end|seealso=*[[api session event editor parametric]]}}
{{article end|seealso=*[[Api session event editor parametric]]
*[[Api session items parametricdesigns]]
}}


[[Category:API]]
[[Category:API]]

Latest revision as of 12:10, 1 April 2026

API Event to Apply

Name Importance Type Description Values
0 REQUIRED (PARAMETRIC_DESIGN Integer ID) Parametric Design
1 REQUIRED (STAKEHOLDER Integer ID) Stakeholder
2 REQUIRED (FunctionType or multiple values in array [a, b, c]) FunctionType[]
3 REQUIRED (Integer number or multiple values in array [1, 2, 3]) Integer[]
4 REQUIRED (MultiPolygon or multiple values in array [a, b, c]) MultiPolygon[][]

Response Codes

Response Code: Description
200 Integer[] (Integer array)
300-600 Codes Overview

Example POST

Example POST: https://engine.tygron.com/api/session/event/editorparametric/apply/?f=JSON&token=API_TOKEN

with content:

[ 10, 36, [ "BUILDING", "SIDEWALK", "GARDEN" ], [ 1, 2, 3 ], [ [ {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799369.134454882 ], [ 658745.5042595589, 6799369.134454882 ], [ 658745.5042595589, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799381.908148949 ], [ 658789.3039617377, 6799381.908148949 ], [ 658789.3039617377, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
} ], [ {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799337.1345314 ], [ 658700.9736961377, 6799337.1345314 ], [ 658700.9736961377, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799421.17784276 ], [ 658772.557494474, 6799421.17784276 ], [ 658772.557494474, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
} ], [ {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799430.268091854 ], [ 658687.9659901621, 6799430.268091854 ], [ 658687.9659901621, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799382.614641199 ], [ 658681.0780289881, 6799382.614641199 ], [ 658681.0780289881, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
} ] ] ]