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
This operation creates a new task.
Properties
Name | Type | Occurrence | Description |
---|---|---|---|
category |
xs:string |
Optional | The category of task. This accepts expression inside &[…], which is evaluated to string. |
customFields |
Array<captureCustomQuestionType> |
Optional | Custom task field types to render for user to enter extended task data. This param is ignored for BPM Approvals. |
details |
xs:string |
Optional | A more detailed description with additional information that may be needed to assist with the completion of the tasks. This accepts expression inside &[…], which is evaluated to string. |
dueDate |
xs:string |
Optional | The date/time that the is expected to be completed by. If not specified then there is no due date defined. This accepts expression inside &[…], which is evaluated to dateTime. |
extra |
xs:string |
Optional | for holding extra info, currently used by core to store task checklist. |
objectRefUrn |
xs:anyURI |
Optional | Reference to an object specified by its URN |
options |
taskOptionsType |
Optional | Set one or more options for this task. |
owner |
xs:string |
Optional | The user account that is the owner of this task. If not specified then the user who created the task becomes the owner. This accepts expression inside &[…], which is evaluated to string. |
priority |
taskPriorityType |
Optional Default= normal |
Identifies the priority of the task. If not specified, a default value of ‘normal’ is used. This accepts expression inside &[…], which is evaluated to string. |
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. This accepts expression inside &[…], which is evaluated to Integer. |
reference |
xs:string |
Optional | Reserved for SYSTEM use and it’s ReadOnly |
remindAssignee |
xs:boolean |
Optional Default= true |
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 Default= true |
Should owner be sent reminder notifications about task’s due for completion date. |
startDate |
xs:string |
Optional | The date/time that work is expected to commence. If not specified then not startDate will be set. This accepts expression inside &[…], which is evaluated to dateTime. |
timeSpent |
xs:unsignedInt |
Optional | The default amount of time (in minutes) to set for timeSpent when creating task. |
title |
xs:string |
Required | The short description of the task to be actioned. This accepts expression inside &[…], which is evaluated to string. |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document