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 / taskGetInfo

  • Article
  • 4 minutes to read

Description

This operation gets the specified task information.

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

Request Parameters

The taskGetInfo 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
taskId xs:string Required The unique task identifier

Response Parameters

Name Type Attributes Description
status taskStateType Required The current status of the task
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 Required 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
appointment xs:boolean Optional
Default=false		 DEPRECATED: If set ‘true’, then this task is an appointment only.
appointmentId xs:string Optional DEPRECATED: If ‘appointment’ set ‘true’, then this is the appointment Id.
category xs:string Optional The category of task.
reference xs:string Optional Reserved for SYSTEM use and it’s ReadOnly. The system defined references are workspaceJoin, bpmTask and bpmApproval
createdOn xs:dateTime Required The date/time that the task was created on
createdBy accountIdType Required The user account that created the task
startDate xs:dateTime Optional The date/time that work is expected to commence. If not specified then not startDate will be set
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.
scheduleRef xs:unsignedInt Optional The schedule job ID that created this task
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 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’
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
assignedTo xs:anyURI Optional The user, group or role this task is assigned to.
assignedToGroup xs:anyURI Optional The group this task is assigned to.
owner accountIdType Required The user account that is the owner of this task.
outcomes xs:string Required A comma separated list of possible outcome values for this task
outcomeInfo Array<taskOutcomeType> Optional Information about each outcome for this task
outcome xs:string Optional The outcome of the task
private xs:boolean Optional DEPRECATED: This is a private appointment (the details of the subject and details are hidden from everyone except the owner)
completedOn xs:dateTime Optional The date/time this task was completed.
completedBy accountIdType Optional The user account that completed this task.
showInCalendar xs:boolean Optional
Default=false		 DEPRECATED: 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. It stores the BPM Id if task is associated to a BPM or Activity Stream Id if task is for workspace join request
objectRefUrn xs:anyURI Optional Application defined object reference URN, mainly used for storing Entity reference URN
reminder xs:duration Optional Duration before due date when reminder notifications should be sent out.
remindAssignee xs:boolean Optional
Default=true		 Should assignee be sent reminder notifications about task due date.
remindOwner xs:boolean Optional
Default=true		 Should owner be sent reminder notifications about task due date.
completionDetails xs:string Optional Notes related to the task completion.
extra xs:string Optional A JSON structure representing additional content for the task.
application appNameType Optional Name of the application this task belongs to.
customFields Array<captureCustomQuestionType> Optional Custom task field types to render for user to enter extended task data
outcomeAnswers Array<keyValueStringToStringType> Optional Answers related to specific outcome
taskAnswers Array<keyValueStringToStringType> Optional Answers related to specific task
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document