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

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Entity API / addProject

  • Article
  • 7 minutes to read

Operation Information

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

Description

This flowcode operation creates a new project.

Request Parameters

The addProject 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
name xs:string No The name of the project.
description xs:string No A description of the project.
projectScope xs:string No The scope of the project.
projectTypeId xs:integer No The primary key of the project type.
qualityStatement xs:string No The project's quality statement.
scheduledStartDate xs:dateTime No The project's scheduled start date.
scheduledEndDate xs:dateTime No The project's scheduled end date.
startDate xs:dateTime No The project's actual start date.
endDate xs:dateTime No The project's actual end date.
status xs:string Yes The status of the project. Accepted values are (status.draft, status.active).
subStatus xs:string No The Project Sub Status value taken from the simple list. e.g. 'subStatus.pipeline'
businessProcess xs:string No The id of the business process that will run against the project.
budgetCurrency xs:string No The currency of the project's budget.
budget xs:decimal No The project's budget.
projectTemplateId xs:integer No The primary key of the project template.
projectManagerId xs:string No The user id of the project manager of the new project. Specifying a project manager will override the application setting of making the project creator the project manager.
businessBenefits xs:string No Business benefits of the project.
lessonsLearnt xs:string No Lessons learnt during the project.
reasons xs:string No Reasons for doing the project.
customA1 xs:string No Custom Field A1 (varchar).
customA2 xs:string No Custom Field A2 (varchar).
customA3 xs:string No Custom Field A3 (varchar).
customA4 xs:string No Custom Field A4 (varchar).
customA5 xs:string No Custom Field A5 (varchar).
customB1 xs:string No Custom Field B1 (text).
customB2 xs:string No Custom Field B2 (text).
customB3 xs:string No Custom Field B3 (text).
customB4 xs:string No Custom Field B4 (text).
customB5 xs:string No Custom Field B5 (text).
customC1 xs:dateTime No Custom Field C1 (datetime).
customC2 xs:dateTime No Custom Field C2 (datetime).
customC3 xs:dateTime No Custom Field C3 (datetime).
customC4 xs:dateTime No Custom Field C4 (datetime).
customC5 xs:dateTime No Custom Field C5 (datetime).
customD1 xs:integer No Custom Field D1 (integer).
customD2 xs:integer No Custom Field D2 (integer).
customD3 xs:integer No Custom Field D3 (integer).
customD4 xs:integer No Custom Field D4 (integer).
customD5 xs:integer No Custom Field D5 (integer).
relatedRequestId xs:string No The id of a Service Manager request to link to the project.
relatedRequestType xs:string No The type of relationship to the related request. E.g. projectRelationship.connectedTo

Response Parameters

Name Type Description
outcome xs:string The outcome of the flowcode operation.
projectId xs:integer The id of the new project.
projectName xs:string The name of the new project.
warnings xs:string Any errors encountered when spawning a business process against the new project.

Code Examples

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document