addPortfolioChildren

Purpose

This operation adds one or more child portfolios to a parent portfolio.

Function

You can use this operation to add a set of child portfolios to a parent portfolio.

Limitations

The maximum number of child portfolios that can be added to a parent is 40.

Related Information

The following related operation:

Input

The following fields are required:

  • The ID of the parent portfolio

  • An array of IDs of the child portfolios that need to be added to the parent portfolio

Return

This operation does not return any data.

Java Interface

AddPortfolioChildrenResponseDocument addPortfolioChildren(AddPortfolioChildrenDocument in)

Parameters

Description

AddPortfolioChildrenDocument

Wrapper for the input of this operation.

The input includes the following fields:

  • Long id //parent portfolio ID

  • Long[] childrenIds //IDs of child portfolios

Java Examples

public void testAddPortfolioChildren(long parentPortfolioId,
long[] ids) throws Exception {
       System.out.println("testAddPortfolioChildren started
...");
      PortfolioServiceStub PFM = new PortfolioServiceStub(ctx,
WSURL);
      AddPortfolioChildrenDocument addChildrenDoc =
AddPortfolioChildrenDocument.Factory.newInstance();
      AddPortfolioChildren children =
addChildrenDoc.addNewAddPortfolioChildren();
      children.setPortfolioIdsArray(ids);
      children.setParentPortfolioId(parentPortfolioId);
      PFM.addPortfolioChildren(addChildrenDoc);
      System.out.println("testAddPortfolioChildren
completed");
      }

Errors and Exceptions

When an error occurs on this operation, you will see a description of the root cause in the server log or in the response message:

The server log content is similar to the following:

Exception in thread "main" org.apache.axis2.AxisFault:
<exception:exceptionDetails xmlns:exception="http://
www.mercury.com/ppm/ws/exception">
<exception:detail>[root cause description] </exception:detail>
</exception:exceptionDetails>

Possible root cause descriptions:

Message Code

Message

Cause(s)

Possible Corrective Action

exception.authorization

You do not have the privilege to take this action. Please consult your PPM Administrator.

You are not authorized to create a portfolio.

Check the user licenses and privileges (access grants)

com.mercury.itg.exceptions.ObjectNotFoundException

Cannot load the {0} with the specified id: {1}. {0} may be deleted by another user.

A portfolio with the specified name or ID cannot be found.

Check the portfolio name or ID.