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

Tasks / Get

Operation Information

Get a Projects Task.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type ActiveCollab.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose ActiveCollab in the Type pick list;
  • Give the ActiveCollab KeySafe key a Title (this is the name / identifier for the ActiveCollab account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Account ID string The Account ID for the ActiveCollab account
Email Address string The email address/user ID of the ActiveCollab user
Password string Authentication Password
Client Name string The Client Name for the ActiveCollab token
API Token string Please leave this field blank, as it's populated by the system,

Tip

The Account ID, above, can be found in your ActiveCollab URL as so: https://app.activecollab.com/YOURACCOUNTID/projects.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked ActiveCollab account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Project ID projectId integer This is the ID of the project whose task you want to GET. Yes None provided
Task ID taskId integer This is the ID of the projects task you want to GET. Yes None provided

Output Parameters

Display Name ID Type Description
Error Message error string The error of your api call
Status Code status string The status of your api call
Task Name name string The name of your task
Task URL urlPath string The url path to your task
Completed on completedOn string The date time that the task was completed on
Task Completed by (User ID) completedById integer The Id of the user who completed the task
Task Complete isCompleted string The status of the task
Task Created On createdOn string The date time of the task creation
Task Creator createdByEmail string The email of the user who created the task
Task Due Date dueOn string The due date of the task
Task Start Date startedOn string The date the task was started on
Estimated Duration (m) estimate string The estimated time of task completion
Task Body body string The content of the task
In This Document