admUpdateProject
Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !
Availability
This routine is available starting with katl-commons 2.5.8.
Syntax
admUpdateProject(pkey, pname, description, lead, url, categoryName, defaultIsUnassigned, avatarId)
Starting with version 4.0.11
admUpdateProject(pkey, pname, description, lead, url, categoryName, defaultIsUnassigned, avatarId, projectTypeKey)
Description
Updates the project properties.
The project key cannot be changed, it's the only thing that identifies the project.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
pkey | string | yes | Project key. Must exist. |
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 | 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. |
projectTypeKey | string | no | Set the project type key. |
Return type
boolean
Returns 'true' if the project was updated and 'false' if not.
Example
Example 1
admUpdateProject("T3", "Thunderbolt3", "Three thunderbolts in a single hole", "zeus", "http://thunderbolts.olimpus.gr", "PUBLIC", false, 12010);
Example 2
admUpdateProject("T3", "Thunderbolt3", "Three thunderbolts in a single hole", "zeus", "http://thunderbolts.olimpus.gr", "PUBLIC", false, 12010, "software");
You will need permissions to update the project.