searchTask
- Description
- This transaction searches for tasks that meet a given set of criteria. The level of detail returned depends on whether an inquiry level is provided in the request.
- Web Services
- Operation name: searchTask
- Example
- Search for tasks that have been assigned to a specific task owner.
Search for all tasks that have: a given task name, a task status, and a due date within a given date range.
- Usage information
- Seven search criteria are available:
- Task name
- Task category type
- Task status type
- Task owner
- Entity name
- InstancePK with entity name
- Task start due date and end due date
To facilitate searching for active or inactive tasks represented by different statuses, multiple task statuses are allowed in a search request. Six predefined task statuses are provided.
Tasks with the following predefined statuses are considered active:
- 1 = New
- The task does not have a task owner.
- 2 = Pending
- The task is currently assigned to a task owner.
- 3 = In Progress
- The task has been worked on.
- 6 = Returned
- The task has been returned for correction.
- 7 = Stopping
- The task is being stopped.
- 8 = Stopped
- The task has been stopped.
Tasks with the following statuses are considered inactive:
- 4 = Completed
- The task is complete.
- 5 = Terminated
- The task has been terminated.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- Any one or more of the following elements:
- TaskName
- TaskCatType
- TaskStatusType
- TaskOwner
- EntityName
- InstancePK with EntityName
- TaskDueDateStart and TaskDueDateEnd
- Inquiry levels
- InquiryLevel:
Level 0 – returns task search results plus, for each returned task, the InstancePK and EntityName.
Note: The inquiry level is optional. - Filter values
- Not applicable
- Transaction behavior
- Wildcard (%) and look-alike (?) characters are supported for the
TaskName element. Single, multiple, or a combination of wildcard and
look-alike characters are allowed if they are used with a partial
TaskName. Restriction: Wildcard characters generally cannot be used in numeric or timestamp fields.
When a value is not provided for TaskDueDateStart, but a value is provided for TaskDueDateEnd, then the transaction response will return all tasks due on or before the given End date.
When a value is not provided for TaskDueDateEnd, but a value is provided for TaskDueDateStart, then the transaction response will return all tasks due on or after the given Start date.
With the exception of the EntityName, entity descriptions are not returned with the entity's InstancePK.
This transaction allows you to search using multiple task statuses as criteria.
- Request message
- <TCRMTxType> searchTask
<TCRMTxObj> TaskSearchBObj
<TCRMObj> TaskSearchBObj
- Response objects
- Depending on the presence of the inquiry level:
- No inquiry level provided – List of TaskSearchResultBObj
- 0 – TaskSearchResultBObj plus a list of TaskBObj with WorkbasketBObj
- Special note
- Not applicable