admUpdateProjectComponent

Availability

This routine is available starting with SIL Engine™ 4.0.16

Syntax

admUpdateProjectComponent(componentStructure)

Description

Updates a project component.

Parameters

Parameter name

Type

Required

Description

componentStructureJComponentyesStructure containing the component data to be updated. Component id is mandatory.

The componentStructure parameter should have the JComponent type described here.

Return type

string
You can safely ignore the return value of this routine.

Example

JComponent comp = admGetProjectComponent("AP", "compName");
comp.name = "compName - updated";
comp.description = "compDesc";
comp.lead = "JIRAUSER10000"; // The user key must be entered here.
comp.defaultAssignee = 2;
admUpdateProjectComponent(comp);


When setting the component lead, the user key must be passed. If you would like to use the user name instead, consider using usernameToUserKey() to convert to user key.


See also