admCreateProjectWithSharedConfiguration

admCreateProjectWithSharedConfiguration

 

Syntax

admCreateProjectWithSharedConfiguration(pkey, pname, description, lead, url, categoryName, defaultIsUnassigned, avatarId, pkeyForScheme[, projectTypeKey])

Package

adm

Alias

 

Pkg Usage

createProjectWithSharedConfig(pkey, pname, description, lead, url, categoryName, defaultIsUnassigned, avatarId, pkeyForScheme[, projectTypeKey])

Description

Creates a new project, optionally offering support for category of the project. Creates the project and configures it with the security level, workflow scheme, etc, as in another project.
After creating the project will attempt to copy the following schemes:

  • Field Configuration Scheme

  • Issue Security Scheme

  • Issue Type Scheme

  • Issue Type Screen Scheme

  • Notification Scheme

  • Permission Scheme

  • Workflow Scheme

 

Parameters

Parameter name

Type

Required

Description

Parameter name

Type

Required

Description

pkey

String

Yes

Project key

pname

String

Yes

Project name.

description

String

Yes

Project description.

lead

String

Yes

Represents a valid user that should be assignable on the project.

url

String

Yes

URL of the project. Leave blank if no URL is available.

categoryName

String

Yes

Name of the category.

defaultIsUnassigned

Boolean (true/false)

Yes

Set it to 'true' if you don't want to assign issues to the project lead above.

avatarId

numeric

Yes

Set it to a negative number or zero for the default avatar id. Otherwise, you need to choose a valid avatar id.

pkeyForScheme

String

Yes

Project key whose scheme you want to use.

projectTypeKey

String

No

Set the project type key. If it is not set, the default value is "business". This function will not work for Service Desk project type.

Return Type

Boolean (true/false)

Returns 'true' if the project was created and scheme was applied. In other case returns 'false'.

Examples

Example 1

admCreateProjectWithSharedConfiguration("T3", "Thunderbolt3", "Three thunderbolts in a single hole", "zeus", "http://thunderbolts.olimpus.gr", "PUBLIC", false, 0, "OLYMP");

Example 2

admCreateProjectWithSharedConfiguration("T3", "Thunderbolt3", "Three thunderbolts in a single hole", "zeus", "http://thunderbolts.olimpus.gr", "PUBLIC", false, 0, "OLYMP", "business");

 

 

  • Attempts to create a project with the same key or name as an existing project will result in an error

  • Executing user must have permissions to create projects

 

 

See also

Need support? Create a request with our support team.

Copyright © 2005 - 2026 Appfire | All rights reserved.