9 Portfolio Resource API

This ClearTrial Web Services API returns information about portfolio resources from ClearTrial applications.

Get Portfolios

Lists all the portfolios accessible to the current user for a given customer ID.

Method: GET

URL: /cleartrial-ws/portfolios

Sample output in JSON:

{
 "List": [
    {
     "id": 10201,
     "name":"Sample Portfolio 1",
     "code":"Sample Portfolio 1 short description",
     "description":"Sample Portfolio 1 long description",
     "createdBy":"administrator",
     "createdDate":"02-May-2011",
     "lastModifiedBy":"administrator",
     "lastModifiedDate":"02-May-2011",
     "plan": [
        {
         "id": 12001,
         "url":"/cleartrial-ws/plans/12001"
        },
        ...
        ...
      ],
     "url":"/cleartrial-ws/portfolios/10201"
    },
    {
     "id": 10202,
     "name":"Sample Portfolio 2",
      ...
      ...
    }
    ...
    ...
  ]
}

Sub-Resources: None

Get Portfolio

Obtains the representation for a specified portfolio.

Method: GET

URL: /cleartrial-ws/portfolios/{portfolioID}

Sample output in JSON:

{
 "List": {
   "id": 10201,
   "name":"Sample Portfolio 1",
   "code":"Sample Portfolio 1 short description",
   "description":"Sample Portfolio 1 long description",
   "createdBy":"administrator",
   "createdDate":"02-May-2011",
   "lastModifiedBy":"administrator",
   "lastModifiedDate":"02-May-2011",
   "plan": [
      {
       "id": 12001,
       "url":"/cleartrial-ws/plans/12001"
      },
      {
        ...
        ...
      }
      ...
      ...
    ],
   "url":"/cleartrial-ws/portfolios/10201"
  }
}

Sub-Resources: None