GET v1/EntityPortfolios/Entities/

Retrieves all entities for the specified portfolio.

Request Information

Parameters

Name Type Description Additional information
request EntityPortfoliosGetEntitiesRequest Container for the EntityPortfoliosGetDetailsRequest input parameters. See parameter details below.

Define this parameter in the request URI.

Parameter Information

Parameter Name: request

Property Type Description
Id Int32 The ID of the Portfolio.
InsiteId String Optional - Insite Id.
SdkVersion String If the client is using the SDK, the version number will be passed along with the request. This field is optional.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "entities": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "cashWeight": 1.0
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "cashWeight": 1.0
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "cashWeight": 1.0
    }
  ],
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "id": 1,
    "insiteId": "sample string 2",
    "sdkVersion": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<EntityPortfoliosGetEntitiesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </ErrorMessages>
  <ErrorOccurred>false</ErrorOccurred>
  <Request>
    <SdkVersion>sample string 3</SdkVersion>
    <Id>1</Id>
    <InsiteId>sample string 2</InsiteId>
  </Request>
  <Entities>
    <PortfolioEntity>
      <CashWeight>1</CashWeight>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </PortfolioEntity>
    <PortfolioEntity>
      <CashWeight>1</CashWeight>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </PortfolioEntity>
    <PortfolioEntity>
      <CashWeight>1</CashWeight>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </PortfolioEntity>
  </Entities>
</EntityPortfoliosGetEntitiesResponse>