Get List Of App Instances: The GetListOfAppInstances method retrieves a list of a app’s instances.
REQUEST ATTRIBUTES
firstInstanceId |
int |
The app's first instance number (incrementing integer, starting at 1 for the first submitted instance of the app.) The method will return a list of instances having a higher number than the one specified in this parameter |
|---|---|---|
appId |
string |
This is the app ID obtained from the app's API reference link |
tokenIn |
string |
This is the security token that is obtained by the previous API call. See API Security topic for more details |
RETURN ATTRIBUTES
GetListOfAppInstancesResult |
int |
An integer result indicating success (= 0) or an error (<> 0) |
|---|---|---|
instancesList |
string |
The list of app instances in xml format |
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/GetListOfAppInstances HTTP/1.1 Host: <server url> Content-Type: multipart/form-data
Content-Disposition: form-data; name="firstInstanceId" int Content-Disposition: form-data; name="appId" string Content-Disposition: form-data; name="tokenIn" string |
HTTP/1.1 200 OK Content-Length: length Content-Type: application/json; charset=utf-8 { "GetListOfAppInstancesResult":int, "instancesList":string, "tokenOut":string } |
Return to: Account API Methods (REST), Integration
