PortFolioAPI

/portfolio.do?cmd=AddPortfolio

GET /portfolio.do?cmd=AddPortfolio

Portfolio

Summary

Add new Portfolio.

Description

Add new Portfolio.

Access

Account Admin
Project Manager

Parameters

Name

Located in

Description

Required

Schema

portfolioSummaryMetrics

query

Provide comma separated project summary field id's

No

Object

type:"string"

string

portfolioProjectMetrics

query

Provide comma seperated project matrics field id's

No

Object

type:"string"

string

portfolioProjectFields

query

Provide comma sperated project field Id's.

No

Object

type:"string"

string

portfolioProject

query

Provide the highlighted projects with sort order in JSON as shown here.

Yes

Object

type:"string"

string

selectedProjectIds

query

Provide comma sepeated projectIds selected for portfolio.

Yes

Object

type:"string"

string

styleAttribute

query

Provide Style attribute JSON as mentioned here

No

Object

type:"string"

string

portfolioSummary

query

Provide Portfolio Summary text.

No

Object

type:"string"

string

titleSlideFileId

query

Provide file Id for Title slide.

No

Object

type:"string"

integer

logoFileId

query

Provide file Id for Logo.

Yes

Object

type:"string"

integer

title

query

Provide Title of the portfolio.

Yes

Object

type:"string"

string

useReviewFileFlag

query

Enable(1), Disable(2) for "Use latest approved Review file when no files are tagged 'Final Deliverable'"

No

Object

type:"string"

integer

displayTeamFlag

query

Enable(1), Disable(2) for "Display Project Team Members"

No

Object

type:"string"

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema`: Result Portfolio saved successfully. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_portfolio_success_api_add_portfolio", "detailedMessage": "Portfolio saved successfully.", "exception": null, "browser": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36", "sessionId": "09D276C94BF06B5017DDD17A4C6E4CB9", "customParams": { "portfolioId": 10434 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema`: Result

Success

Schema: Result

Portfolio saved successfully.

Sample JSON

																
Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_portfolio_success_api_add_portfolio",
  "detailedMessage": "Portfolio saved successfully.",
  "exception": null,
  "browser": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36",
  "sessionId": "09D276C94BF06B5017DDD17A4C6E4CB9",
  "customParams": {
    "portfolioId": 10434
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema: Result

/portfolio.do?cmd=UpdatePortfolio

GET /portfolio.do?cmd=UpdatePortfolio

Portfolio

Summary

Update Portfolio.

Description

Update Portfolio.

Access

Account Admin
Project Manager

Parameters

Name

Located in

Description

Required

Schema

portfolioId

query

Provide the portfolio id which has to update.

No

Object

type:"string"

integer

portfolioSummaryMetrics

query

Provide comma separated project summary field id's

No

Object

type:"string"

string

portfolioProjectMetrics

query

Provide comma seperated project matrix field id's

No

Object

type:"string"

string

portfolioProjectFields

query

Provide comma sperated project field Id's.

No

Object

type:"string"

string

portfolioProject

query

Provide the highlighted projects with sort order in JSON as shown here.

Yes

Object

type:"string"

string

selectedProjectIds

query

Provide comma sepeated projectIds selected for portfolio.

Yes

Object

type:"string"

string

styleAttribute

query

Provide Style attribute JSON as mentioned here

No

Object

type:"string"

string

portfolioSummary

query

Provide Portfolio Summary text.

No

Object

type:"string"

string

titleSlideFileId

query

Provide file Id for Title slide.

No

Object

type:"string"

integer

logoFileId

query

Provide file Id for Logo.

Yes

Object

type:"string"

integer

title

query

Provide Title of the portfolio.

Yes

Object

type:"string"

string

useReviewFileFlag

query

Enable(1), Disable(2) for "Use latest approved Review file when no files are tagged 'Final Deliverable'"

No

Object

type:"string"

integer

displayTeamFlag

query

Enable(1), Disable(2) for "Display Project Team Members"

No

Object

type:"string"

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema`: Result Portfolio updated successfully. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_portfolio_success_api_add_portfolio", "detailedMessage": "Portfolio saved successfully.", "exception": null, "browser": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36", "sessionId": "09D276C94BF06B5017DDD17A4C6E4CB9", "customParams": { "portfolioId": 10434 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema`: Result

Success

Schema: Result

Portfolio updated successfully.

Sample JSON

																
Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_portfolio_success_api_add_portfolio",
  "detailedMessage": "Portfolio saved successfully.",
  "exception": null,
  "browser": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36",
  "sessionId": "09D276C94BF06B5017DDD17A4C6E4CB9",
  "customParams": {
    "portfolioId": 10434
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema: Result

/portfolio.do?cmd=GetPortfolioDetails

GET /portfolio.do?cmd=GetPortfolioDetails

Portfolio

Summary

Get portfolio details.

Description

Get portfolio details for given portfolioId.

Access

Project Manager+

Parameters

Name

Located in

Description

Required

Schema

portfolioId

query

Provide the portfolio id which which want to fetch.

Yes

Object

type:"string"

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema`: Portfolio Portfolio fetched successfully.
Failure	Unexpected error `Schema`: Result

Success

Schema: Portfolio

Portfolio fetched successfully.

Failure

Unexpected error

Schema: Result

/portfolio.do?cmd=GetMyPortfolioList

GET /portfolio.do?cmd=GetMyPortfolioList

Portfolio

Summary

Get portfolio list.

Description

Get active portfolio list.

Access

Project Manager+

Parameters

Name	Located in	Description	Required	Schema

Responses

Response Type Description

Response Type	Description
Success	`Schema`: { Portfolio } Portfolios fetched successfully.
Failure	Unexpected error `Schema`: Result

Success

Schema: { Portfolio }

Portfolios fetched successfully.

Failure

Unexpected error

Schema: Result

/portfolio.do?cmd=GetMyExpiredPortfolioList

GET /portfolio.do?cmd=GetMyExpiredPortfolioList

Portfolio

Summary

Get expired portfolio list.

Description

Get expired portfolio list.

Access

Project Manager+

Parameters

Name	Located in	Description	Required	Schema

Responses

Response Type Description

Response Type	Description
Success	`Schema`: { Portfolio } Portfolios fetched successfully.
Failure	Unexpected error `Schema`: Result

Success

Schema: { Portfolio }

Portfolios fetched successfully.

Failure

Unexpected error

Schema: Result

/portfolio.do?cmd=GetPortfolioUrl

GET /portfolio.do?cmd=GetPortfolioUrl

Portfolio

Summary

Get portfolio Preview URL

Description

Get portfolio Preview URL.

Access

Project Manager+

Parameters

Name

Located in

Description

Required

Schema

portfolioId

query

Provide the portfolio id which which want to fetch.

Yes

Object

type:"string"

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema`: URL String
Failure	Unexpected error `Schema`: Result

Success

Schema: URL String

Failure

Unexpected error

Schema: Result

/portfolio.do?cmd=GetGlobalSummaryMetrics

GET /portfolio.do?cmd=GetGlobalSummaryMetrics

Portfolio

Summary

Get Global summary matrics list.

Description

Get Global summary matrics list.

Access

Project Manager+

Parameters

Name	Located in	Description	Required	Schema

Responses

Response Type Description

Response Type	Description
Success	`Schema`: { PortfolioSummaryMetric } Summary matrics fetched successfully.
Failure	Unexpected error `Schema`: Result

Success

Schema: { PortfolioSummaryMetric }

Summary matrics fetched successfully.

Failure

Unexpected error

Schema: Result

/portfolio.do?cmd=GetGlobalProjectMetrics

GET /portfolio.do?cmd=GetGlobalProjectMetrics

Portfolio

Summary

Get Global Project summary matrics list

Description

Get Global Project summary matrics list.

Access

Project Manager+

Parameters

Name	Located in	Description	Required	Schema

Responses

Response Type Description

Response Type	Description
Success	`Schema`: { PortfolioProjectMetric } Project matrics fetched successfully.
Failure	Unexpected error `Schema`: Result

Success

Schema: { PortfolioProjectMetric }

Project matrics fetched successfully.

Failure

Unexpected error

Schema: Result

/portfolio.do?cmd=GetFinalDeliverableFileList

GET /portfolio.do?cmd=GetFinalDeliverableFileList

Portfolio

Summary

List all files having Final Deliverable standard Tag for Selected Projects.

Description

List all files having Final Deliverable standard Tag for Selected Projects.

Access

Account Admin
Project Manager

Parameters

Name

Located in

Description

Required

Schema

selectedProjectIds

query

Provide comma seperated portfolio id's.

Yes

Object

type:"string"

string

sortColumn

query

Provide sort column from your output columns.

Yes

Object

type:"string"

string

sortDirection

query

Provide sort direction => (ASC or DESC)

Yes

Object

type:"string"

string

Responses

Response Type Description

Response Type	Description
Success	`Schema`: { FinalDeliverableProjectFile } Final Deliverable Project Files fetched successfully.
Failure	Unexpected error `Schema`: Result

Success

Schema: { FinalDeliverableProjectFile }

Final Deliverable Project Files fetched successfully.

Failure

Unexpected error

Schema: Result

Abbreviations

Protfolio Project Json Format

Protfolio Style Attribute JSON.

Summary

Description

Access

Parameters

Responses

Summary

Description

Access

Parameters

Responses

Summary

Description

Access

Parameters

Responses

Summary

Description

Access

Parameters

Responses

Summary

Description

Access

Parameters

Responses

Summary

Description

Access

Parameters

Responses

Summary

Description

Access

Parameters

Responses

Summary

Description

Access

Parameters

Responses

Summary

Description

Access

Parameters

Responses