ReassignTask API¶

Reassigns an active workflow task to a different user with a new due date and instructions. The original task is marked as Reassigned and a new task is created for the target user. Task attachments and requirements are inherited by the new task.

Endpoint¶

/srv.asmx/ReassignTask

Methods¶

• GET /srv.asmx/ReassignTask?authenticationTicket=...&taskId=...&reassignTo=...&newDueDate=...&newInstructions=...&sendTaskNotice=...
• POST /srv.asmx/ReassignTask (form data)
• SOAP Action: http://tempuri.org/ReassignTask

Parameters¶

Response¶

Success Response¶

<response success="true">
  <Value>
    <TaskId>4813</TaskId>
    <AssigneeId>15</AssigneeId>
    <AssigneeFullName>Alice Jones</AssigneeFullName>
    <RedirectedfromUserId>0</RedirectedfromUserId>
    <RedirectedfromUserFullName></RedirectedfromUserFullName>
  </Value>
</response>

Error Response¶

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

Response Field Reference¶

Required Permissions¶

The calling user must be either: - The current task assignee, or - A workflow supervisor for the task.

Anonymous access is not permitted.

Eligible Task States¶

Only tasks in the following states can be reassigned:

What Happens on Success¶

1. The original task status is set to Reassigned.
2. A new task is created for the reassignTo user with status InProgress and the specified newDueDate and newInstructions.
3. All task attachments from the original task are copied to the new task.
4. Task requirements (Approval, Sign, ISOReview, etc.) are inherited from the original task.
5. If the reassignTo user has an active task redirection, the task is automatically forwarded to their redirect target and RedirectedfromUserId is populated in the response.
6. Email notifications are sent to the original assignee and the original task assigner. If sendTaskNotice=true, the new assignee also receives a notification.

Example¶

GET Request¶

GET /srv.asmx/ReassignTask
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &taskId=4812
    &reassignTo=alice.jones
    &newDueDate=2024-04-15T17:00:00
    &newInstructions=Please review and approve by end of month.
    &sendTaskNotice=true
HTTP/1.1
Host: yourserver

POST Request¶

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

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&taskId=4812&reassignTo=alice.jones&newDueDate=2024-04-15T17:00:00&newInstructions=Please+review+and+approve+by+end+of+month.&sendTaskNotice=true

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

Hands a task to somebody else. It does not move the task: it closes the original as reassigned and opens a new one with a new id, which the answer reports.

const root = await call('ReassignTask', {
  authenticationTicket: ticket,
  taskId: 7328,
  reassignTo: 'ajones',
  newDueDate: '2098-06-01',
  newInstructions: 'Please look at this instead.',
  sendTaskNotice: false
});

const newTaskId = root.querySelector('Value > TaskId').textContent;
console.log(newTaskId, root.querySelector('AssigneeFullName').textContent);

The original id stops accepting changes afterwards - UpdateTaskStatus on it answers 4000 "this task has been reassigned".

Notes¶

• The reassignTo parameter is a login name, not a display name or user ID.
• newDueDate must be a future date. Passing a past date returns an error.
• If newInstructions is empty, the instructions field of the new task will be empty. Pass the original instructions explicitly if they should be preserved.
• The TaskId in the response is the new task ID, not the original. Use this ID for subsequent calls such as CompleteTask or GetTask.
• To obtain the original task ID, use getTasks or GetTask before calling ReassignTask.

Related APIs¶

• GetTask -" Get full details of a task including its current status.
• getTasks -" Get a filtered list of tasks.
• CompleteTask -" Mark a task as completed.
• DeleteTask -" Delete a task.
• ChangeTaskDueDate -" Change the due date without reassigning.

Error Codes¶

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