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}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - bpmTaskCreateType

  • Article
  • 2 minutes to read

Description

This operation creates a new task.

Properties

Name Type Occurrence Description
title xs:string Required The short description of the task to be actioned. This accepts expression inside &[…], which is evaluated to string.
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.
options taskOptionsType Optional Set one or more 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. This accepts expression inside &[…], which is evaluated to string.
category xs:string Optional The category of task. This accepts expression inside &[…], which is evaluated to string.
reference xs:string Optional Reserved for SYSTEM use and it’s ReadOnly
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.
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.
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.
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”.
timeSpent xs:unsignedInt Optional The default amount of time (in minutes) to set for timeSpent when creating task.
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.
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.
objectRefUrn xs:anyURI Optional Reference to an object specified by its URN
customFields Array<captureCustomQuestionType> Optional Custom task field types to render for user to enter extended task data. This param is ignored for BPM Approvals.
extra xs:string Optional for holding extra info, currently used by core to store task checklist.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document