Newer
Older
# EventReplayApi
All URIs are relative to *http://localhost/sandboxname/sandbox-ctrl/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createReplayFile**](EventReplayApi.md#createReplayFile) | **POST** /replay/{name} | Add a replay file
[**createReplayFileFromScenarioExec**](EventReplayApi.md#createReplayFileFromScenarioExec) | **POST** /replay/{name}/generate | Generate a replay file from Active Scenario events
[**deleteReplayFile**](EventReplayApi.md#deleteReplayFile) | **DELETE** /replay/{name} | Delete a replay file
[**deleteReplayFileList**](EventReplayApi.md#deleteReplayFileList) | **DELETE** /replay | Delete all replay files
[**getReplayFile**](EventReplayApi.md#getReplayFile) | **GET** /replay/{name} | Get a specific replay file
[**getReplayFileList**](EventReplayApi.md#getReplayFileList) | **GET** /replay | Get all replay file names
[**getReplayStatus**](EventReplayApi.md#getReplayStatus) | **GET** /replaystatus | Get status of replay manager
[**loopReplay**](EventReplayApi.md#loopReplay) | **POST** /replay/{name}/loop | Loop-Execute a replay file present in the platform store
[**playReplayFile**](EventReplayApi.md#playReplayFile) | **POST** /replay/{name}/play | Execute a replay file present in the platform store
[**stopReplayFile**](EventReplayApi.md#stopReplayFile) | **POST** /replay/{name}/stop | Stop execution of a replay file
<a name="createReplayFile"></a>
# **createReplayFile**
> createReplayFile(name, replay-file)
Add a replay file
Add a replay file to the platform store
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| replay file name | [default to null]
**replay-file** | [**Replay**](../Models/Replay.md)| Replay-file |
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="createReplayFileFromScenarioExec"></a>
# **createReplayFileFromScenarioExec**
> createReplayFileFromScenarioExec(name, replayInfo)
Generate a replay file from Active Scenario events
Generate a replay file using events from the latest execution of a scenario
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| replay file name | [default to null]
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
**replayInfo** | [**ReplayInfo**](../Models/ReplayInfo.md)| Replay information |
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="deleteReplayFile"></a>
# **deleteReplayFile**
> deleteReplayFile(name)
Delete a replay file
Delete a replay file by name from the platform store
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| replay file name | [default to null]
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="deleteReplayFileList"></a>
# **deleteReplayFileList**
> deleteReplayFileList()
Delete all replay files
Delete all replay files present in the platform store
### Parameters
This endpoint does not need any parameter.
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="getReplayFile"></a>
# **getReplayFile**
> Replay getReplayFile(name)
Get a specific replay file
Get a replay file by name from the platform store
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| replay file name | [default to null]
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
### Return type
[**Replay**](../Models/Replay.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getReplayFileList"></a>
# **getReplayFileList**
> ReplayFileList getReplayFileList()
Get all replay file names
Returns a list of all replay files names present in the platform store
### Parameters
This endpoint does not need any parameter.
### Return type
[**ReplayFileList**](../Models/ReplayFileList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getReplayStatus"></a>
# **getReplayStatus**
> ReplayStatus getReplayStatus()
Get status of replay manager
Returns status information on the replay manager
### Parameters
This endpoint does not need any parameter.
### Return type
[**ReplayStatus**](../Models/ReplayStatus.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="loopReplay"></a>
# **loopReplay**
> loopReplay(name)
Loop-Execute a replay file present in the platform store
Loop-Execute a replay file present in the platform store
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| replay file name | [default to null]
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="playReplayFile"></a>
# **playReplayFile**
> playReplayFile(name)
Execute a replay file present in the platform store
Execute a replay file present in the platform store
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| replay file name | [default to null]
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="stopReplayFile"></a>
# **stopReplayFile**
> stopReplayFile(name)
Stop execution of a replay file
Stop execution a replay file
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| replay file name | [default to null]
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined