This function sets or clears the hold flag on the specified transaction. Setting the hold flag on an executing transaction has no effect, with the exception that if Arbortext Publishing Engine terminates before the transaction completes, the hold will be applied after Arbortext Publishing Engine restarts.

In addition to id and response-format, this function takes the parameter hold. If the request specifies hold=yes, the transaction is held. If the request specifies hold=no, the hold flag is removed.

If this request specifies an immediate request or does not identify an active transaction, this function will return an error.