Factory Reset

To begin a new test cycle, you can reset the test environments by using Factory Reset operation. This operation will reset the environment to its freshly installed state that is the state in which it is originally delivered.

A reset operation permanently deletes the environment configurations.

Factory Reset operation is allowed in non-production environments and only work with the same major application release version.

To perform the factory reset operation, submit the following POST requests and confirm the operation:

HTTP Method	POST
Base URL	http:// <app-deployment-name>/workRequest/create/reset
Content-Type	application/json

Response Example

The successful creation of a request returns a 200 OK response with the following response body:

{
    "uuid": "<uuid>",
    "requestType": "reset",
    "status": "<statusType>",
    "requestInfo": "{<request_Information>}",
    "createdBy": "<user_name>",
    "createdAt": "2022-05-31T06:04:18.39486333Z",
    "updatedBy": null,
    "lastUpdatedAt": "2022-05-31T06:04:18.394870245Z",
    "confirm": "https:// <app-deployment-name>/console/workRequest/confirm/{uuid}",
    "cancel": "https:// <app-deployment-name>/console/workRequest/cancel/{uuid}"
}

Error Response

Besides, the 2OO responses, this endpoint returns the 4xx responses when any other operation is in-progress.

Confirm the Reset Operation

To confirm the reset operation, send the following GET request with the appropriate UUID:

HTTP Method	GET
Base URL	http:// <app-deployment-name>/workRequest/confirm/{uuid}
Content-Type	application/json

Here, replace {uuid} with an uuid value that returned by POST http:// <app-deployment-name>/workRequest/create/reset

Response Example

{
    "uuid": "<uuid>",
    "requestType": "reset",
    "status": "COMPLETED",
    "requestInfo": "{<requestType>}",
    "createdBy": "<user_name>",
    "createdAt": "2022-05-17T06:02:14.908Z",
    "updatedBy": null,
    "lastUpdatedAt": "2022-05-17T06:16:54.409Z",
    "confirm": null,
    "cancel": null
}

You can also confirm the work request by clicking on the confirm URL return in the POST http:// <app-deployment-name>/workRequest/create/reset response body. It redirects you to the GET request body and then sends the request.

Cancel the Reset Operation

You can cancel the operation within ten minutes by sending the following GET request with the appropriate UUID:

HTTP Method	GET
Base URL	http:// <app-deployment-name>/workRequest/cancel/{uuid}
Content-Type	application/json

Response Example

{
    "uuid": "<uuid>",
    "requestType": "reset",
    "status": "CANCELED",
    "requestInfo": "{<requestInfo>}",
    "createdBy": "<user_name>",
    "createdAt": "2022-05-17T06:02:14.908Z",
    "updatedBy": null,
    "lastUpdatedAt": "2022-05-17T06:16:54.409Z",
    "confirm": null,
    "cancel": null
}

You can also cancel the work request by clicking on the cancel URL returned in the POST http:// <app-deployment-name>/workRequest/create/reset response body. It redirects you to the GET request body and then sends the request.