removePortfolioChildren

Purpose

This operation removes one or more child portfolios from a parent portfolio.

Function

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

Related Information

The following related operation:

• addPortfolioChildren

Input

The following fields are required:

• The ID of the parent portfolio

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

Return

This operation does not return any data.

Java Interface

RemovePortfolioChildrenResponseDocument removePortfolioChildren(RemovePortfolioChildrenDocument in)

Parameters	Description
RemovePortfolioChildrenDocument	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 testRemovePortfolioChildren(long parentPortfolioId,
long[] ids) throws Exception {
       System.out.println("testRemovePortfolioChildren started
...");
       PortfolioServiceStub PFM = new PortfolioServiceStub(ctx,
WSURL);
       RemovePortfolioChildrenDocument delChildrenDoc =
RemovePortfolioChildrenDocument.Factory.newInstance();
       RemovePortfolioChildren children =
delChildrenDoc.addNewRemovePortfolioChildren();
       children.setPortfolioIdsArray(ids);
       children.setParentPortfolioId(parentPortfolioId);
       PFM.removePortfolioChildren(delChildrenDoc);
       System.out.println("testRemovePortfolioChildren
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.