Set Stage: The SetStage method allows you to set the stage of a specific instance.
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) |
instanceName |
string |
When you change the stage you can re-name the instance |
isClosedStage |
boolean |
If true the stage is closed and no more actions are permitted |
stageId |
string |
The ID of the new stage |
stageName |
string |
The name of the new stage |
tokenIn |
string |
This is the security token that is obtained by the previous API call. See API Security topic for more details |
RETURN ATTRIBUTES
SetStageResult |
int |
An integer result indicating success (= 0) or an error (<> 0) |
|---|---|---|
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/SetStage 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="instanceName" string Content-Disposition: form-data; name="isClosedStage" boolean Content-Disposition: form-data; name="stageId" string Content-Disposition: form-data; name="stageName" string Content-Disposition: form-data; name="tokenIn" string |
HTTP/1.1 200 OK Content-Length: length Content-Type: application/json; charset=utf-8 { "SetStageResult":int, "tokenOut":string } |
Return to: Account API Methods (REST), Integration
