path /api/snapshot (for Hyperon Studio versions 1.6.40 and older)
/api/snapshot/export (since 1.6.41 Hyperon Studio version)
method: POST
produces: application/zip
return code:
- 200 - if successful,
- 500 - when something went wrong
request body is optional. If the request body is empty, then export will try to fetch an active profile from the given user or all profiles in the system, if the user has no active profile.
In Parameters settings block attribute fromSession might take two values for Snapshot export:
- false - exports user's perspective. So it means both published and unpublished user's changes.
- true - exports only unpublished user's changes.
Request body since hyperon studio version 1.8.14 (still valid, but may change in future versions):
{
"profiles":["PROFILE_1"],
"domain": {
"fromSession" : false,
"removeElementsNotInSnapshot": false
},
"functions": {
"fromSession": true ,
"removeElementsNotInSnapshot": false
"nameStartsWith": ["demo.", "test2"]
},
"parameters": {
"fromSession": false ,
"removeElementsNotInSnapshot": true
"nameStartsWith": ["demo.motor.coverage"]
},
"tags": false ,
"profile": true
}
Request body since Hyperon Studio version 1.6.41
{
"profiles":["PROFILE_1"],
"domain": {
"fromSession" : false
},
"functions": {
"fromSession": true ,
"removeElementsNotInSnapshot": false
"nameStartsWith": ["demo.", "test2"]
},
"parameters": {
"fromSession": false ,
"removeElementsNotInSnapshot": true
"nameStartsWith": ["demo.motor.coverage"]
},
"tags": false ,
"profile": true
}
IMPORTANT
The previous request body from version 1.6.38 is still valid and works the same.
request body since hyperon studio version - 1.6.39:
{
"profiles":["PROFILE_1"],
"domain": {
"fromSession" : false
},
"functions": {
"fromSession": true ,
"nameStartsWith": ["demo.", "test2"]
},
"parameters": {
"fromSession": false ,
"nameStartsWith": ["demo.motor.coverage"]
},
"tags": false ,
"profile": true
}
request body up until hyperon studio version - 1.6.38:
{
"profiles":["PROFILE_1", "PROFILE_2"],
}