summaryrefslogtreecommitdiff
path: root/docs/api.txt
blob: b1b486d26ea4ea4df196f8389292b44c1381fb34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
GET /categories/

Status Code

200

Response JSON - Array of maps of

id
name
sort_order



GET /blocks/

Status Code

200

Response JSON - Array of maps of

id
blocktype
name
categories
initial_ports - Array of maps of
  port_name
  port_number
  port_type
  port_orientation
initial_display_parameter
block_image_path
p000_value_initial
p001_value_initial
...
p038_value_initial
p039_value_initial



GET /block_parameters/

Status Code

200

Response JSON - Array of maps of

id
p000
p000_type
p001
p001_type
...
p038
p038_type
p039
p039_type



POST /setblockparameter

Input JSON - Map of

block_id
p000_value
p001_value
...
p038_value
p039_value

Status Code

200

Response JSON - Map of

variable_ports - Array of maps of
  port_name
  port_number
  port_type
  port_orientation
variable_display_parameter



POST /simulate/

Input MxGraph Block Diagram

Status Code

200

Response JSON - simulation_id



GET /stopsimulation/{simulation_id}/

Status Code

200

Response JSON -



GET /getsimulationoutput/{simulation_id}/

Status Code

200

Response Text - streaming



POST /uploadscript/{script_type_id}/

Input Script File

Status Code

200

Response JSON - script_id



POST /executescript/{script_type_id}/

Input Script File

Status Code

200

Response JSON - script_execution_id


GET /stopscript/{script_execution_id}/

Status Code

200

Response JSON -


GET /getscriptoutput/{script_execution_id}/

Status Code

200

Response JSON - Array of

variable
value