API Reference
Start typing to search…

Search portfolios

get https://{host}/platform/riskdata/v1/exposures//portfolios

Returns list of portfolios.

A portfolio is a collection of accounts. Intelligent Risk Platform analyzes a portfolio of accounts as a unit and produces portfolio-level results.

This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.

Path Params
int64
required
≥ 1

ID of EDM.

Query Params
string

Query string to select response data based on property values.

PropertyComparisonList
portfolioId= != > < >= <=IN NOT IN
portfolioNumber=, != LIKE NOT LIKEIN NOT IN
portfolioName= != LIKE NOT LIKEIN NOT IN
description= != LIKE NOT LIKEIN NOT IN
ownerName= != LIKE NOT LIKEIN NOT IN
createDate= != > < >= <=IN NOT IN
stampDate= != > < >= <=IN NOT IN

This parameter also supports logical operators (AND, OR) for defining compound expressions. See Filtering Responses.

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: createDate, description, portfolioId, portfolioName, portfolioNumber, stampDate. See Response Pagination.

int32

Number of records returned per page. See Response Pagination

int32

Number of the page displaying the returned records, starting at 0

Responses

Response body
array of objects
object
int32

ID of portfolio.

string
required
length between 0 and 40

Name of portfolio.

string
required
length between 0 and 20

Number of portfolio.

string
required
length between 0 and 255

Description of portfolio.

string

Timestamp in 8601 format, i.e. YYYY-MM-DDThh:mm:ss.sss

string

Timestamp in 8601 format, i.e. YYYY-MM-DDThh:mm:ss.sss

string
string
string

List of hazard models run on this portfolio.

string

Name of owner.

string

Timestamp in 8601 format, i.e. YYYY-MM-DDThh:mm:ss.sss

tagIds
array of int32s

List of tags to apply to portfolio. See Tags.

tagIds

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
Request

Updated 5 months ago

Did this page help you?