SetTaskApprovalStatus API¶

Sets the approval decision on a workflow task. This is used for tasks that have an Approval requirement, where the assignee must record their approval decision (Approve or Reject) before completing the task.

Endpoint¶

/srv.asmx/SetTaskApprovalStatus

Methods¶

• GET /srv.asmx/SetTaskApprovalStatus?authenticationTicket=...&taskId=...&approvalDecision=...
• POST /srv.asmx/SetTaskApprovalStatus (form data)
• SOAP Action: http://tempuri.org/SetTaskApprovalStatus

Parameters¶

Approval Decision Values¶

Any other value returns an error.

Response¶

Success Response¶

<response success="true" error="" errorCode="0" />

Error Response¶

<response success="false" error="Access denied." errorCode="4030" />

Required Permissions¶

The calling user must be the current task assignee.

Anonymous access is not permitted.

Eligible Task States¶

The task must be in one of the following states:

Example¶

GET Request¶

GET /srv.asmx/SetTaskApprovalStatus
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &taskId=4812
    &approvalDecision=6
HTTP/1.1
Host: yourserver

POST Request¶

POST /srv.asmx/SetTaskApprovalStatus HTTP/1.1
Host: yourserver
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&taskId=4812&approvalDecision=6

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Records the approval decision on a task. approvalDecision takes three values and nothing else: 0 no status, 5 reject, 6 approve.

await call('SetTaskApprovalStatus', { authenticationTicket: ticket, taskId: 7328, approvalDecision: 6 });

const root = await call('GetTask', { authenticationTicket: ticket, taskId: 7328 });
console.log(root.querySelector('ApprovalStatus').textContent);   // "Approved"

GetTask reports the decision as NoResult, Rejected or Approved.

Notes¶

• Setting the approval status does not complete the task. Call CompleteTask after setting the approval status to advance the workflow.
• To clear a previously set decision, pass approvalDecision=0.
• To retrieve a task's current approval status, use GetTask and inspect the ApprovalStatus field.
• Approval decisions are only meaningful for tasks that have an Approval requirement type. The field is stored but has no effect on tasks without this requirement.

Related APIs¶

• GetTask -" Get full details of a task including its current approval status.
• CompleteTask -" Mark a task as completed and advance the workflow.
• SetTaskComment -" Set the comment on a task.
• TestTaskCompletion -" Check whether a task can be completed based on its requirements.

Error Codes¶

The errorCode values this operation returns, checked against a running server: