POST Unassign Txn

The transaction unassign operation unassigns a submission task specified in the query.

To assign a task, the following requirements must be met.

• The form status is not "completed" or "abandoned".
• The task is not assigned to a group.
• The transaction is a task, and the taskKey not empty.
• The task 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/unassign

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

Supported unassign attributes

The supported unassign attributes are listed below.

caution

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

Attribute	Description
submitKey	String Required. The submit key property of the task to assign.

Response

If successful (that is, the task is unassigned 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
accessDenied	The user does not have access to transaction specified by the submitKey	400 Bad Request
internalServerError	500 Internal Server Error
notGroupTask	The transaction specified by the submitKey is not group assigned transaction	400 Bad Request
submitKeyNotSpecified	submitKey not specified	400 Bad Request
txnAlreadyFinished	The transaction specified by the submitKey is already been finished (Completed or Abandoned)	400 Bad Request
txnNotFound	The transaction specified by the submitKey was not found	400 Bad Request
txnNotTask	The transaction specified by the submitKey is not a task	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 unassign. Contact administrator.

Example

Ensure you specify Content-Type: application/json.

Example request

POST /workspaces/secure/api/v1/txn/unassign HTTP/1.1
Host: https://transact.workspaces.com
Content-Type: application/json
{
    "params": {
        "submitKey": "15d071280b92c867f86975b9cd2e8765"
    }
}