Get App Instance Meta Data: The GetAppInstanceMetaData method returns an app instance's meta data.
REQUEST ATTRIBUTES
appId |
string |
This is the app ID obtained from the app's API reference link |
|---|---|---|
instanceId |
int |
This is the app's instance number (incrementing integer, starting at 1 for the first submitted instance of the app) |
tokenIn |
string |
This is the security token that is obtained by the previous API call. See API Security topic for more details |
RETURN ATTRIBUTES
appInstanceName |
string |
|
|---|---|---|
appInstanceNumber |
int |
|
GetAppInstanceMetaDataResult |
int |
An integer result indicating success (= 0) or an error (<> 0) |
link |
string |
|
majorVersion |
short |
|
minorVersion |
short |
|
stageId |
string |
|
stageName |
string |
|
tokenOut |
string |
This is the new security token that should be used for the next function call after this one. See the API Security topic for more details |
REST
The following is a sample REST request and response. The placeholders shown need to be replaced with actual values.
POST /REST/api/portal/GetAppInstanceData HTTP/1.1 Host: <server url> Content-Type: multipart/form-data
Content-Disposition: form-data; name="appId" string Content-Disposition: form-data; name="instanceId" int Content-Disposition: form-data; name="tokenIn" string |
HTTP/1.1 200 OK Content-Length: length Content-Type: application/json; charset=utf-8 { "appInstanceName":string, "appInstanceNumber":int, "GetAppInstanceMetaDataResult":int, "link":string, "majorVersion":short, "minorVersion":short, "stageId":string, "stageName":string, "tokenOut":string } |
Return to: Account API Methods (REST), Integration
