dms.ModPortfolio

This job adds objects to an existing portfolio or deletes all objects in the portfolio. If the portfolio is restricted to an object type and it is attempted to add objects of a different object type, this will result in an error.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Currently not supported → pass 0

Mode

INT

Yes

1 = all objects contained in the portfolio are deleted, otherwise 0

PortfolioXML

BASE64

Yes

Description of the portfolio in XML format

2. Return Value

(INT): 0 = Job successful, otherwise error code
Complete list of error codes

Job-specific return values:

  • -40: The portfolio specified in PortfolioXML does not exist.

  • -47: A folder to be added does not exist. The rights check precedes the existence check, so the job reports missing rights instead of an unknown object.

  • -1073: A document to be added does not exist. dms.AddPortfolio reports the same case with -22.

Architecture of PortfolioXML (Description: see Portfolio XML Format)
<Portfolio>
  <Objects>
    <Object>
</Object>
  </Objects>
</Portfolio>