Post Refresh Request API

Initiate Post Refresh Request

Authentication - Use Basic Authentication for this API.

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..

API URL

http://host:port/flexdeploy/rest/v1/topology/environmentinstance/{environmentId}/{instanceId}/initiatepostrefresh

Request

Parameter
Required
Type
Description

environmentId

YesURL

This is the target environment Id. This is the environment that will be refreshed through builds and deploys.

instanceIdYesURLThis is the instance Id for which the two environments are associated. This instance must be associated with both environments.
refreshEnvironmentIdYesLongThe 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
requestedStartDateNoString

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.

requestedStartTimeString

 The requested start time that was given.

targetEnvironmentIdLong

The Id for the target environment.

postRefreshIdLong

The post refresh request Id.

refreshEnvIdLongThe Id for the refresh from environment.

Response Codes

HTTP Code
Description
201Post refresh request initiated successfully
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Environment instance not found
500Unexpected 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.

In response we will receive a post refresh request.

Test Instance GET Return JSON
 {
   "instanceId": 22223,
   "requestedStartTime": "Fri Dec 13 11:01:32 CST 2019",
   "targetEnvironmentId": 18802,
   "postRefreshId": 54321,
   "refreshEnvId": 22331
}

Test Instance - 11101
{
	"refreshEnvironmentId": 12345
}