Table of Contents

Search

  1. Preface
  2. Overview, Downloading, and Installing
  3. Administration API
  4. Identity Service API
  5. Screenflow Programming and SDK
  6. ActiveVOS WSHT API
  7. Embedding Request Forms in Standalone Web Pages
  8. XML-JSON for Process Central

7. APIs, SDKs, and Services

7. APIs, SDKs, and Services

Parameters Used In GetMyTasks Request

Parameters Used In GetMyTasks Request

The previous example showed how to get a list of tasks using the
getMyTasks
operation. The basic request message is:
<htdt:getMyTasks xmlns:htdt="http://www.example.org/WS-HT/api/xsd"> <htdt:taskType/> <htdt:genericHumanRole/> <htdt:workQueue/> <htdt:status/> <htdt:whereClause/> <htdt:createdOnClause/> <htdt:maxTasks/> </htdt:getMyTasks>
The key elements in this request are:
Element
Possible Values
Notes
<htdt:taskType/>
  • TASKS
  • NOTIFICATIONS
  • ALL
Indicates whether to return tasks, notifications, or both
<htdt:genericHumanRole/>
  • POTENTIAL_OWNERS
  • OWNER
  • ADMINISTRATORS
  • NOTIFICATION_RECIPIENTS
  • INITIATOR
  • STAKEHOLDERS
Optional element. If this element is not provided, the server uses POTENTIAL_OWNER (and implicitly the OWNER)
<htdt:workQueue/>
group/role name
Optional element. Name of group/role. The user must be a member of the group.
<htdt:status/>
  • READY (unclaimed - ready to be claimed)
  • RESERVED (claimed)
  • IN_PROGRESS (started)
  • SUSPENDED
  • EXITED
  • FAILED
  • ERROR
  • COMPLETED
  • OBSOLETE
This is a repeating element. Include more than one to simulate "OR" across two or more values. For example, including the following two elements filters the result set to tasks that are claimed (RESERVED) or started (IN_PROGRESS) by current user:
<htdt:status>IN_PROGRESS</htdt:status>
<htdt:status>RESERVED</htdt:status>
<htdt:whereClause/>
Where clause string.
Optional element. Filter by using a simple where clause. For example,
  • By taskId: "Task.ID = urn:b4p:8765309" // should only return 1 task.
  • By owner: "Task.Owner = jenny" // All tasks owned by jenny (reserved, in_progress, completed, failed)
  • By priority: "Task.Priority = 3"
  • By search by: "Task.PrimarySearchBy = customerid-8765309"
<htdt:createdOnClause/>
Optional Element. Filter by the date task was created. For example,
Task.CreatedOn = 2009-10-05T11:14:00Z
The date should be a schema dateTime (xsd:dateTime) formatted value.
<htdt:maxTasks/>
Maximum number of tasks to be returned. Integer value (> 0).
Optional Element.