Documentation

This is taking longer than usual. If nothing appears, refresh the page.

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

  • Article
  • 3 minutes to read

Description

The information of the tasks.

Properties

Name Type Occurrence Description
taskId xs:string Required The unique task identifier.
status taskStateType Required The current status of the task.
title xs:string Required The short description of the task to be actioned.
priority taskPriorityType Optional
Default=normal		 Identifies the priority of the task. If not specified, a default value of ‘normal’ is used.
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.
category xs:string Optional The category of task.
reference xs:string Optional Reserved for SYSTEM. The system defined references are workspaceJoin, bpmTask and bpmApproval
owner xs:string Required The task owner id.
createdOn xs:dateTime Required The date/time that the task was created on.
outcomes xs:string Required A comma separated list of possible outcome values for this task.
outcomeTypes Array<taskOutcomeType> Optional The configured outcome types.
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.
assignedOn xs:dateTime Optional The date/time this task was last assigned.
updatedOn xs:dateTime Optional The date/time this task was last updated.
outcome taskOutcomeNameType Optional The outcome of the task.
completedOn xs:dateTime Optional The date/time this task was completed.
completedby xs:anyURI Optional The person who completed this task.
objectRefUrn xs:anyURI Optional Reference to an object specified by its URN
details xs:string Optional A more detailed description with additional information that may be needed to assist with the completion of the tasks.
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.
timeSpent xs:unsignedInt Optional The amount of time spent on this task.
timeBillable xs:boolean Optional If set true, indicates that the time spent on this task is billable time.
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 Should assignee be sent reminder notifications about task’s due for completion date.
remindOwner xs:boolean Optional Should owner be sent reminder notifications about task’s due for completion date…
completionDetails xs:string Optional Notes related to the task completion.
startDate xs:dateTime Optional The date/time that work is expected to commence. If not specified then there is no start date defined.
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’.
application xs:string Optional application that this task belongs to
extra xs:string Optional A JSON structure representing additional content for the task
createdDateTimeWindow userTasksListType Optional An indication of the assigned date time box this task belongs
startDateTimeWindow userTasksListType Optional An indication of the start date time box this task belongs
assignedDateTimeWindow userTasksListType Optional An indication of the assigned date time box this task belongs
dueDateTimeWindow userTasksListType Optional An indication of the due date time box this task belongs
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document