DELETE v1/EntityPortfolios/Delete

Deletes an entity portfolio.

Request Information

Parameters

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

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "id": 1,
  "insiteId": "sample string 2",
  "sdkVersion": "sample string 3"
}

application/xml, text/xml

Sample:
<EntityPortfoliosDeleteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <SdkVersion>sample string 3</SdkVersion>
  <Id>1</Id>
  <InsiteId>sample string 2</InsiteId>
</EntityPortfoliosDeleteRequest>

Parameter Information

Parameter Name: request

Property Type Description
Id Int32 The id of the portfolio to be deleted.
InsiteId String Optional - InsiteId parameter.
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:
{
  "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:
<EntityPortfoliosDeleteResponse 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>
</EntityPortfoliosDeleteResponse>