DELETE v1/EntityPortfolios/DeleteItems

Deletes items from an entity portfolio.

Request Information

Parameters

Name Type Description Additional information
request EntityPortfoliosDeleteItemsRequest Container for the EntityPortfoliosDeleteItemsRequest 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",
  "list": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "sdkVersion": "sample string 3"
}

application/xml, text/xml

Sample:
<EntityPortfoliosDeleteItemsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <SdkVersion>sample string 3</SdkVersion>
  <Id>1</Id>
  <InsiteId>sample string 2</InsiteId>
  <List 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>
  </List>
</EntityPortfoliosDeleteItemsRequest>

Parameter Information

Parameter Name: request

Property Type Description
Id Int32 The id of the portfolio to remove items from.
InsiteId String Optional - InsiteId parameter.
List List`1 The list of items to be deleted from the portfolio.
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:
{
  "itemsRemoved": 1,
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "id": 1,
    "insiteId": "sample string 2",
    "list": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    "sdkVersion": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<EntityPortfoliosDeleteItemsResponse 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>
    <List xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </List>
  </Request>
  <ItemsRemoved>1</ItemsRemoved>
</EntityPortfoliosDeleteItemsResponse>