POST Reopen Txn

The transaction reopen operation reverts the specified transaction status from abandoned to saved. This works similarly to the Make Abandoned Transaction Saved action on the Abandoned Transactions page.

To reopen a transaction, it must meet the following requirements.

• The form status is "abandoned".
• The transaction data has not yet been deleted. (Once deleted, the transaction cannot be reverted.)
• The transaction is accessible by the user calling the API.

caution

If any of these conditions are not met, a 400 Bad Request HTTP status code is returned.

Request

HTTP request

POST https://<JM_SERVER>/workspaces/secure/api/v1/txn/reopen

Request body

The POST request must contain a JSON structure describing the txn query. To support multiple parameters, this API uses HTTP Content Type: application/json.

The available query attributes are listed below. All attributes are optional except where otherwise indicated.

caution

If you specify an invalid request attribute, a 400 Bad Request HTTP status code is returned.

Attribute	Description
params	Map Required. A map containing the reopen attributes.

Supported reopen attributes

The supported reopen attributes are listed below.

caution

If you specify an invalid reopen attribute, a 400 Bad Request HTTP status code is returned.

Attribute	Description
milestones	String A submission milestone value to add to the transaction.
submitKey	String Required. The submit key property of the submission/transaction record to reopen.

Response

If successful (that is, the transaction is reopened and no errors occurred during the execution of this API), this operation returns a response with a HTTP 200 OK status code.

Error messages

Error key	Error	HTTP status code
internalError	Please see Error Log ID {number}	500 Internal Server Error
submitKeyNotSpecified	submitKey not specified	400 Bad Request
txnDataDeleted	Transaction data has been deleted, and so the transaction cannot be reverted.	400 Bad Request
txnNotAbandoned	The transaction is not abandoned.	400 Bad Request
txnNotFound	The transaction specified by the submitKey was not found.	400 Bad Request

Error responses

HTTP status code	Description
400 Bad Request	Bad request or request parameter. Check error message for details.
404 Not Found	Ensure the URL endpoint is entered correctly.
500 Internal Server Error	Exception occurred in txn reopen. Contact administrator.

Examples

Ensure you specify Content-Type: application/json.

Example request

POST /workspaces/secure/api/v1/txn/reopen HTTP/1.1
Host: https://transact.workspaces.com
Content-Type: application/json

{
    "params": {
        "milestones": "Application Status: Staff Reopened",
        "submitKey": "15d071280b92c867f86975b9cd2e8765"
    }
}