Application API

Method Endpoint Description
Post Application/OpenApplication Opens specified application. Requires a valid sessionInfo token obtained from the Authentication/Logon method.

Application/OpenApplication

POST https://{BaseWebServer}/Onestreamapi/api/Application/OpenApplication?api-version=7.2.0

Query Parameters

Key Value Required
api-version 7.2.0 Yes

Authorization

Type Value Required
Bearer Token (your access token) Yes

Headers

Key Value Required
Content-Type application/json Yes

Request Body

Key Type Description Required
ApplicationName string Name of the application to open Yes
SI array (bytes) The SessionInfo (SI) object obtained from Authentication/Logon endpoint. Yes

Sample Request

Copy 
{
 "ApplicationName": "GolfStreamDemo_2022",
 "SI": {
 "XfBytes": "QB8AACNodHRwOi8vbG9jYWxob3N0OjUwMDAxL09uZVN0cmVhb
 VdlYhQAAAB7izp1jCP3BUVr8bjD2f6KmmL5BKzhOVWUzU1MikEYOVekOZUIT0
 tUQV9NMk27tnn6+VZaR544CKlYPCFeWSBWCTmQ2ggAAAAAAAAAAAAAAAAAAAA
 AAAAAAAAFZW4tVVMAAAAAAAAAAAAAAAAAAAAAAAAAAP//////////////////
 ////////8P//////////////AwAAABn8//8Z/P//Gfz//xn8//8Z/P//Gfz//
 xn8//8Z/P//Gfz//xn8//8Z/P//Gfz//w=="
 }
}

Sample Response

Copy 
{
 "Message": "Open application succeeded.",
 "Application SessionInfo": {
 "XfBytes": "QB8AACNodHRwOi8vbG9jYWxob3N0OjUwMDAxL09uZVN0
 cmVhbVdlYhQAAAAep0GewgsakcN4GJDmuwyaaIMazfN/aHyhnXNLgg+h
 Uxy6cpQIT0tUQV9NMk27tnn6+VZaR544CKlYPCFe0BusL1iM2ggUAAAA
 rL9Q04ePExHJxVU89Y1MAeNxrh8UT25lU3RyZWFtX0dvbGZTdHJlYW3x
 ShfEXWxvRbOx2hWDSCd0BWVuLVVTAAAAAAAAAAAAAAAAAAAAAAAAAAD/
 /////////wAAAAACAFABAABQAfD///8AAAAAYHzddwMAAABCAfAAGfz/
 /5z///+c////FQAQACYAIAARAGAAAwCQABn8//8Z/P//Gfz//xn8//8="
 }
}