Documentation

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

Entity API / getProjectTasks

Operation Information

  • Application Reference: com.hornbill.projectmanager
  • Scope: Entity - ProjectTasks
  • Class: Entity
  • Required Privilege Level: user
  • Required Rights: Group E - canViewProjectTasks

Description

This flowcode operation gets details of all project tasks that match the search criteria provided.

Request Parameters

The getProjectTasks API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name Type Required Description
projectId xs:integer Yes The primary key of the project.
searchFilter xs:string No Search criteria for project tasks.
filterByStatus xs:string No Filters the results by a valid status value, e.g. status.inPlanning, status.assigned, status.completed, status.cancelled
filterByMilestone xs:integer No Filters the results by a valid milestone id.
filterByAssignee xs:string No Filters the results by a valid assignee.
filterBySummaryTask xs:integer No Filters the results by a valid summary task id.
rowStart xs:integer Yes Row Start for Paging.
rowLimit xs:integer Yes Page Size.
sortDirection xs:string No Either ASC or DESC. Required if sortng by task name, progress, status, assigned to, start date or due date, otherwise the filter will not apply.
sortOnTaskName xs:boolean No Sorts the result set by task name rather than task creation date. Default is false.
sortOnProgress xs:boolean No Sorts the result set by task progress rather than task creation date. Default is false.
sortOnStatus xs:boolean No Sorts the result set by task status rather than task creation date. Default is false.
sortOnAssignedTo xs:boolean No Sorts the result set by task assignee rather than task creation date. Default is false.
sortOnStartDate xs:boolean No Sorts the result set by task start date rather than task creation date. Default is false.
sortOnDueDate xs:boolean No Sorts the result set by task due date rather than task creation date. Default is false.
sortOnRagStatus xs:boolean No Sorts the result set by task RAG status rather than task creation date. Default is false.

Response Parameters

Name Type Description
outcome xs:string The outcome of the flowcode operation.
totalRecordCount xs:integer The total number of project tasks that match the search criteria provided.
projectTasks xs:string A JSON string of project tasks.
projectTaskAssignees xs:string A JSON string of project task assignees.

Code Examples

In This Document