How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Description
The information of the tasks.
Properties
Name | Type | Occurrence | Description |
---|---|---|---|
application |
xs:string |
Optional | application that this task belongs to |
appointment |
xs:boolean |
Required | DEPRECATED: Set to ‘true’ if this is an appointment. |
appointmentId |
xs:string |
Optional | DEPRECATED: If ‘appointment’ is ‘true’ this will contain the appointment ID. |
assignedTo |
xs:anyURI |
Required | The user, group or role this task is assigned to. |
assignedToGroup |
xs:anyURI |
Optional | The group this task is assigned to. |
category |
xs:string |
Optional | The category of task. |
completedOn |
xs:dateTime |
Optional | The date/time this task was completed. |
completionDetails |
xs:string |
Optional | Notes related to the task completion. |
createdOn |
xs:dateTime |
Required | The date/time that the task was created on. |
details |
xs:string |
Optional | A more detailed description with additional information that may be needed to assist with the completion of the tasks. |
dueDate |
xs:dateTime |
Optional | The date/time that the task is expected to be completed by. If not specified then there is no due date defined. |
expires |
xs:dateTime |
Optional | If an expiry date/time is specified here, when the time is reached and the task is still outstanding, the task will be completed with no outcome and set to a state of ‘expired’. |
extra |
xs:string |
Optional | A JSON structure representing additional content for the task |
objectRefUrn |
xs:anyURI |
Optional | Reference to an object specified by its URN |
outcome |
taskOutcomeNameType |
Optional | The outcome of the task. |
outcomes |
xs:string |
Required | A comma separated list of possible outcome values for this task. |
owner |
xs:string |
Required | The task owner id. |
priority |
taskPriorityType |
Optional Default= normal |
Identifies the priority of the task. If not specified, a default value of ‘normal’ is used. |
progress |
percentageValueType |
Optional | In the case where a task will take some time to complete, this can be used to indicate the progress of the work being done. A value between 0-100 is valid. |
reference |
xs:string |
Optional | Reserved for SYSTEM. The system defined references are workspaceJoin, bpmTask and bpmApproval |
remindAssignee |
xs:boolean |
Optional | Should assignee be sent reminder notifications about task’s due for completion date. |
reminder |
xs:duration |
Optional | Duration before task’s due for completion date, when reminder notifications should be sent out. If not specified, default value will be picked from system settings “task.notification.taskDueReminder”. |
remindOwner |
xs:boolean |
Optional | Should owner be sent reminder notifications about task’s due for completion date… |
startDate |
xs:dateTime |
Optional | The date/time that work is expected to commence. If not specified then there is no start date defined. |
status |
taskStateType |
Required | The current status of the task. |
taskId |
xs:string |
Required | The unique task identifier. |
timeBillable |
xs:boolean |
Optional | If set true, indicates that the time spent on this task is billable time. |
timeSpent |
xs:unsignedInt |
Optional | The amount of time spent on this task. |
title |
xs:string |
Required | The short description of the task to be actioned. |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document