Initiate Post Refresh Request
| Include Page | ||||
|---|---|---|---|---|
|
Post refresh requests can be initiated through this API using the POST service.
This POST service will perform the same action found on the Post Refresh requests form off of the Environment Instance page. It will initiate a post refresh request to build and deploy any projects in order to refresh an environment to its original state after that instance has been cloned from another environment. The service will return a post refresh request json object..
| Info | ||
|---|---|---|
| ||
Request
Parameter | Required | Type | Description |
|---|---|---|---|
environmentId | Yes | URL | This is the target environment Id. This is the environment that will be refreshed through builds and deploys. |
| instanceId | Yes | URL | This is the instance Id for which the two environments are associated. This instance must be associated with both environments. |
| refreshEnvironmentId | Yes | Long | The source environment Id. This is the environment that the target environment will be refreshed from. This is the same environment that would be selected in the refreshed from environment drop down on the post refresh requests screen |
| requestedStartDate | N | String | The time when the deployment will be started. Format should yyyy-MM-dd'T'HH:mm:ssXXX. For example, 2019-03-16T21:17:52-06:00 |
Response
Parameter | Type | Description |
|---|---|---|
instanceId | Long | The instance Id that was associated with both the target environment and refresh from environment. |
| requestedStartTime | String | The requested start time that was given. |
| targetEnvironmentId | Long | The Id for the target environment. |
| postRefreshId | Long | The post refresh request Id. |
| refreshEnvId | Long | The Id for the refresh from environment. |
Response Codes
HTTP Code | Description |
|---|---|
| 201 | Post refresh request initiated successfully |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Environment instance not found |
| 500 | Unexpected internal server error |
Example
We can post refresh an environment with Id 10004 from an environment with Id 12345 with the following request. Both environments would be associated with an instance with Id 11101.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/topology/environmentinstance/10004/11101/initiatepostrefresh |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"refreshEnvironmentId": 12345
} |
In response we will receive a post refresh request.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"instanceId": 22223,
"requestedStartTime": "Fri Dec 13 11:01:32 CST 2019",
"targetEnvironmentId": 18802,
"postRefreshId": 54321,
"refreshEnvId": 22331
} |