Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

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!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ task / taskCreate2

  • Article
  • 4 minutes to read

Description

This operation creates a new task.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
sys.b.manageTasks
sys.b.createTask
 --- --- ---

Request Parameters

The taskCreate2 method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
application appNameType Optional Specify the name of the application this task relates to. If not specified then “system” is assumed.
title xs:string Required The short description of the task to be actioned
details xs:string Optional A more detailed description with additional information that may be needed to assist with the completion of the tasks
options taskOptionsType Optional define specific options for this task
priority taskPriorityType Optional
Default=normal		 Identifies the priority of the task. If not specified, a default value of ‘normal’ is used
category xs:string Optional The category of task.
reference xs:string Optional Reserved for SYSTEM use and it’s ReadOnly
startDate xs:dateTime Optional
Nillable		 The date/time that task is expected to commence. If not specified then no startDate will be set
startDuration xs:duration Optional As an alternative to specifying the ‘startDate’ you can specify a duration from the point of creation where the task was created that the startDate should be set. If you specify a ‘startDate’ this parameter will be ignored. If you do not specify this parameter and no ‘startDate’ parameter is defined then no start date will be set. If you want the startDate to be immediate you can specify a zero length duration ‘PT0S’
dueDate xs:dateTime Optional
Nillable		 The date/time that the is expected to be completed by. If this is not specified no dueDate set (unless you specify dueDuration)
dueDuration xs:duration Optional You can specify this as an alternative to specifying the ‘dueDate’. If ‘dueDate’ is specified then this parameter is ignored. If you specify a duration this will set the dueDate to a future time relative to the task creation date.
scheduleRef xs:unsignedInt Optional You can associate the created task with a specific schedule by providing the scheduled job ID
timeSpent xs:unsignedInt Optional The amount of time (in minutes) spent on this task. If not specified then there is no time spent recorded.
timeBillable xs:boolean Optional Indicates that the time spent on this task is billable time.
expires xs:dateTime Optional
Nillable		 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’
expiresDuration xs:duration Optional This parameter specifies the amount of time from the point of task creation that the task will expire. This parameter is ignored if ‘expires’ is specified.
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
assignTo xs:anyURI Optional Specify which user, group or role to assign this task to. If not specified the task is assigned to yourself
assignToGroup xs:anyURI Optional Specify which group to assign this task to.
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
outcome Array<taskOutcomeType> Required Specify up to eight individual task outcomes
appointment xs:boolean Optional
Default=false		 DEPRECATED: INSTEAD USE task::appointmentCreate If set to ‘true’, then this task is an appointment.
location xs:string Optional DEPRECATED: INSTEAD USE task::appointmentCreate The location of this appointment
private xs:boolean Optional DEPRECATED: INSTEAD USE task::appointmentCreate This is a private appointment (the details of the subject and details are hidden from everyone except the owner)
showInCalendar xs:boolean Optional
Default=false		 DEPRECATED: INSTEAD USE task::appointmentCreate If set to ‘true’, then this task should be shown as a calendar item.
referenceId xs:string Optional Reserved for SYSTEM use and it’s ReadOnly
objectRefUrn xs:anyURI Optional Application defined object reference URN, mainly used for storing Entity reference URN
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”.
remindAssignee xs:boolean Optional
Default=true		 Should assignee be sent reminder notifications about task’s due for completion date.
remindOwner xs:boolean Optional
Default=true		 Should owner be sent reminder notifications about task’s due for completion date.
extra xs:string Optional A JSON structure representing additional content for the task
customFields Array<captureCustomQuestionType> Optional Custom task field types to render for user to enter extended task data

Response Parameters

Name Type Attributes Description
taskId xs:string Required The unique task identifier
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document