SetTaskPriority API¶

Sets the priority of a workflow task. Priority helps assignees and supervisors gauge the urgency of pending work.

Endpoint¶

/srv.asmx/SetTaskPriority

Methods¶

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

Parameters¶

Priority Values¶

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 either: - The task assignee who has the Change Priority permission on the task, or - A workflow supervisor for the task.

Anonymous access is not permitted.

Eligible Task States¶

Priority cannot be changed for tasks in Completed state. All other states (InProgress, DueDateChanged, NotStarted, Dropped, Reassigned) are allowed if permissions are satisfied.

Example¶

GET Request¶

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

POST Request¶

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

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

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;
}

Changes a task's priority. taskPriority is the number, not the name: 0 no priority, 1 Low, 5 Normal, 10 High, 11 Urgent.

await call('SetTaskPriority', { authenticationTicket: ticket, taskId: 7328, taskPriority: 10 });

Notes¶

• The Change Priority permission is configured on the workflow task definition. If the assignee does not have this permission, only the supervisor can change the priority.
• To retrieve a task's current priority, use GetTask and inspect the Priority field.

Related APIs¶

• GetTask -" Get full details of a task including its current priority.
• CompleteTask -" Mark a task as completed and advance the workflow.
• SetTaskComment -" Set the comment on a task.
• SetTaskApprovalStatus -" Set the approval decision on a task.
• ChangeTaskDueDate -" Change the due date of a task.

Error Codes¶

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