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

Projects / Create Project

Operation Information

Hornbill Project Manager Integration method for creating a new project.

If a project manager is supplied as an input parameter, it will override the application setting which sets the project creator as the project manager, if indeed this setting is enabled.

This is a Free Tier Integration.

Authentication

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

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 Hornbill Authentication in the Type pick list;
  • Give the Hornbill Authentication KeySafe key a Title (this is the name / identifier for the Hornbill Authentication 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
Instance ID or URL string Hornbill Instance ID or API Endpoint URL
ApiKey string Authentication Key

Tip

Please read the Hornbill API Keys documentation to learn how to create and manage API Keys on the Hornbill platform.

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 Hornbill Authentication account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Name name string the name of the new project No None provided
Description description string a description of the new project No None provided
Project Scope projectScope string the scope of the new project No None provided
Project Type projectTypeId string the new project type No None provided
Quality Statement qualityStatement string the quality statement of the new project No None provided
Scheduled Start Date scheduledStartDate string the scheduled start date of the new project No None provided
Scheduled End Date scheduledEndDate string the scheduled end date of the new project No None provided
Start Date startDate string the actual start date of the new project No None provided
End Date endDate string the actual end date of the new project No None provided
Status status string the status of the new project Yes None provided
Budget Currency budgetCurrency string the currency of the new project’s budget No None provided
Budget budget number the budget of the new project No None provided
Project Template projectTemplateId string the template that the new project should be based on No None provided
Project Manager projectManagerId string the id of the project manager for the new project No None provided

Output Parameters

Display Name ID Type Description
Project Id projectId integer The id of the new project
Warning warning string Any returned warning
In This Document