ResponseAccepted

object

Defines the HTTP 202 Accepted response returned when a request is
accepted for asynchronous processing. Includes the job identifier,
metadata, and links to retrieve the job status or results.

jobIdstring

A unique identifier for the asynchronous job. This ID is used to
track processing progress or retrieve completed results.

Example:16bf1a7a-c883-4424-8810-2f4e9d244d40

_linksobject

A set of hypermedia links providing URLs for polling job status or
accessing results when available.

* Additional properties are NOT allowed.
Show Child Parameters
metadataobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

ResponseGetResults

object

Response get results.

investmentsarray

All fields are nullable. Empty or null value fields are not returned.

Show Child Parameters
metadataobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

ResponseGetView

object

Response containing a view definition and the datapoints included in the
view.

* Additional properties are NOT allowed.
viewDefinitionobjectrequired

Definition of a view, including the datapoints it contains.

* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example

ResponseListViews

object

Response containing entitled view packages and their associated dataset viewIds.

* Additional properties are NOT allowed.
viewsarray[object]required

A view package and the dataset viewIds it contains.

* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example

InputInvestment

object

Investment to query. Investment look up is supported.

* Additional properties are NOT allowed.
idstringrequired

Specifies the investment identifier to query. Accepts performance
IDs, ISINs, security IDs, CUSIPs, trading symbols, and Morningstar
IDs.

idTypestring

Allowed values:performanceIdisinfundCodesecurityIdcusipmsidtradingSymbolindustryCode

Default:performanceId

Example:performanceId

exchangeCountrystring

Specifies exchange country used to look up investment. Accepts
3-character ISO 3166-1 country codes.

>= 3 characters<= 3 characters

Example:USA

domicilestring

Specifies domicile used to look up investment. Accepts 3-character
ISO 3166-1 country codes.

>= 3 characters<= 3 characters

Example:USA

baseCurrencystring

Specifies base currency used to look up investment. Accepts
3-character ISO 4217 currency codes.

Example:USD

exchangeIdstring

Specifies exchange identifier used to look up investment. See the data dictionary for full list of accepted values.

Example:EX$$$$XNAS

Example