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

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{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 taskOutcomeType Optional
Array (0/8)		 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 captureCustomQuestionType Optional
Array (0/∞)		 Custom task field types to render for user to enter extended task data
outcomeAnswers keyValueStringToStringType Optional
Array (0/∞)		 Answers related to specific outcome
taskAnswers keyValueStringToStringType Optional
Array (0/∞)		 Answers related to specific task
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document