Portfolios API

Export Portfolios

GET https://www.clarinetlive.com/api/v3/portfolios?page=<page>&pageSize=<page size>

Request

No body.

Query parameters:

• page optional number. The 1-based page number to return. Defaults to 1 when not specified.
• pageSize optional number. The number of entries to return up to 500. Defaults to 500 when not specified.

The Accept header should be populated with either application/xml or pplication/json to get XML or JSON respectively.

Response

A list of portfolio names and public identifiers.

{
  "portfolios": [
    {
      "name": "Test Portfolio",
      "publicID": "a111a111-a111-11a1-aa1a-11111111a1a1"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 100,
    "totalResults": 1
  }
}

Export Single Portfolio

GET https://www.clarinetlive.com/api/v3/portfolios/{publicID}?page=<page>&pageSize=<page size>

Request

No body.

Query parameters:

• page optional number. The 1-based page number to return. Defaults to 1 when not specified.
• pageSize optional number. The number of entries to return up to 500. Defaults to 500 when not specified.

The Accept header should be populated with either application/xml or pplication/json to get XML or JSON respectively.

Response

A list of portfolio names and public identifiers.

{
  "$schema": "http://schemas.clearlifeltd.com/clarinet/standard/v1.0",
  "portfolio": {
    "@name": "Test Portfolio",
    "cases": [ 
      {
        "id": "Test Case",
        "publicID": "a000a000-a000-00a0-aa0a-00000000a0a0"
      },
    ],
    "pagination": {
      "currentPage": 1,
      "pageSize": 100,
      "totalResults": 1
    }
  }
}