Management API

Base Resource URL:


                    https://[server-name]/api/v01/portfolios

Description:

Provides access to portfolios registered within the system.

Available sub-resources:

Resource URL	Description
https://[server-name]/api/v01/portfolios/[portfolio-code]	Code of a portfolio on which action is required.

Supported Actions:

create

Method: PUT	Implicit: Yes	Returns: Portfolio *
Consumes: json, xml, xurl		Produces: json, xml, xurl

Creates Portfolio with default portfolio code.

Parameters:

#	Name	Type	Required	Default	Description
01	userName	String	No		User that will have access to the portfolio.
02	portfolio	Portfolio	Yes		Portfolio parameters. Represents portfolio object without sub-components.
03	notificationPolicy	Portfolio	No	default	If the "default" value is used, the email notification upon portfolio creation will be sent out to creator. Represents portfolio object without sub-components.

find

Method: GET	Implicit: Yes	Returns: Portfolio[] *
Consumes: not applicable		Produces: json, xml, xurl

Returns list of available portfolios based on the specified search conditions.

Parameters:

#	Name	Type	Required	Default	Description
01	offset	Integer	No	0	Index of the first record returned to the customer from the search result of a web search.
02	limit	Integer	No	100	Maximum number of records to load per single search web call made by the customer.
03	сreateDate.from	Date	No		Query parameter to search portfolios by their creation date. All portfolios created within the date range defined will be included.
04	сreateDate.to	Date	No		Query parameter to search portfolios by their creation date. All portfolios created within the date range defined will be included.
05	portfolioName	String(255)	No		Query parameter to search portfolios by full name (soundex on full name is supported as well).
06	code	Integer	No		Query parameter to search portfolios by code.
07	id	Integer	No		Query parameter to search portfolios by id.
08	active	Boolean	No		Query parameter to search portfolios by activity status.

load

Method: GET	Implicit: Yes	Returns: Portfolio
Consumes: xurl		Produces: json, xml

Returns portfolio based on specified code.

modify

Method: POST	Implicit: No	Returns: Portfolio *
Consumes: json, xml, xurl		Produces: json, xml, xurl

Updates the selected portfolio with the specified values.

Parameters:

#	Name	Type	Required	Default	Description
01	object	Portfolio *	No		Updated object information. Represents portfolio object without sub-components.