Portfolio and Roadmap

Portfolio and Roadmap Connector

This connector is available in the following products and regions:

Service Class Regions
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC)
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC)
     -   China Cloud operated by 21Vianet
Connector Metadata
Publisher Microsoft

Portfolio and Roadmap

Reference

In this article

  • Actions
  • Definitions

Portfolio and Roadmap Connector

This connector was previously know as Project Roadmap connector. This connector is available in the following products and regions:

Service Class Regions
Power Automate Standard All Power Automate regions except the following:
- US Government (GCC)
- China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
- US Government (GCC)
- China Cloud operated by 21Vianet

Connector Metadata

| Publisher | Microsoft |

Actions

This operation is used to retrieve the PortfolioLink associated with a portfolio in a Roadmap. This object contains information about the external project that this portfolio is linked to.

This operation is used to retrieve all the RoadmapItemLinks associated with a portfolio in a Roadmap. RoadmapItemLinks contain information about the external tasks that are imported in this portfolio.

This operation is used to update the PortfolioLink associated with a portfolio in a Roadmap.

This operation is used to update a RoadmapItemLink.

Operation ID: GetPortfolioLink

This operation is used to retrieve the PortfolioLink associated with a portfolio in a Roadmap. This object contains information about the external project that this portfolio is linked to.

Parameters

Name Key Required Type Description
Organization Name organization True string Name of Dynamics 365 organization like Contoso
Portfolio Id portfolioid True guid Id of the Portfolio connected to an external project

Returns

Object describing external project linkage information for a Portfolio

Body

PortfolioLink

Operation ID: GetRoadmapItemLinksForPortfolio

This operation is used to retrieve all the RoadmapItemLinks associated with a portfolio in a Roadmap. RoadmapItemLinks contain information about the external tasks that are imported in this portfolio.

Parameters

Name Key Required Type Description
Organization Name organization True string Name of Dynamics 365 organization like Contoso
Portfolio Id portfolioid True guid Id of the Portfolio connected to an external project

Returns

List of RoadmapItemLinks

Body

RoadmapItemLinks

Operation ID: UpdatePortfolioLink

This operation is used to update the PortfolioLink associated with a portfolio in a Roadmap.

Parameters

Name Key Required Type Description
Organization Name organization True string Name of Dynamics 365 organization like Contoso
Portfolio Id portfolioid True guid Id of the Portfolio connected to an external project
id id string Id of the PortfolioLink
portfolioItemId portfolioItemId guid Id of the portfolio item associated with this link
externalProjectId externalProjectId string Id of the project in the external tool
externalProjectName externalProjectName string Name of the project in the external tool
externalUrl externalUrl string Url of the project in the external tool
refreshErrorCode refreshErrorCode integer Errorcode for refresh errors occuring during scheduled refresh
refreshError refreshError string Error description occuring during scheduled refresh
refreshStartDate refreshStartDate date-time Latest refresh start time
refreshEndDate refreshEndDate date-time Latest refresh end time
refreshStatus refreshStatus integer Last refresh operation status

Returns

Object describing external project linkage information for a Portfolio

Body

PortfolioLink

Operation ID: UpdateRoadmapItemLink

This operation is used to update a RoadmapItemLink.

Parameters

Name Key Required Type Description
Organization Name organization True string Name of Dynamics 365 organization like Contoso
Portfolio Id portfolioid True guid Id of the Portfolio connected to an external project
RoadmapItem Id roadmapitemid True guid Id of the RoadmapItem parent of the roadmap item link to be updated
id id string Id of the RoadmapItemLink
roadmapItemId roadmapItemId string Id of the parent roadmap item that this link is associated with
externalProjectId externalProjectId string Id of the project in the external tool that is linked with the parent portfolio of this link
externalTaskId externalTaskId string Id of the task in the external tool that is associated with this link
externalName externalName string Name of the task in the external tool
externalUrl externalUrl string Url of the task in the external tool
externalStartDate externalStartDate date-time Start date of the task in the external tool
externalDueDate externalDueDate date-time Due date of the task in the external tool
refreshErrorCode refreshErrorCode integer Errorcode for refresh errors occuring during scheduled refresh
refreshError refreshError string Error description occuring during scheduled refresh

Returns

Object describing external task linkage for a single item under a portfolio.

Body

RoadmapItemLink

Definitions

Object describing external project linkage information for a Portfolio

Name Path Type Description
id id string Id of the PortfolioLink
portfolioItemId portfolioItemId guid Id of the portfolio item associated with this link
externalProjectId externalProjectId string Id of the project in the external tool
externalProjectName externalProjectName string Name of the project in the external tool
externalUrl externalUrl string Url of the project in the external tool
refreshErrorCode refreshErrorCode integer Errorcode for refresh errors occuring during scheduled refresh
refreshError refreshError string Error description occuring during scheduled refresh
refreshStartDate refreshStartDate date-time Latest refresh start time
refreshEndDate refreshEndDate date-time Latest refresh end time
refreshStatus refreshStatus integer Last refresh operation status

Object describing external task linkage for a single item under a portfolio.

Name Path Type Description
id id string Id of the RoadmapItemLink
roadmapItemId roadmapItemId string Id of the parent roadmap item that this link is associated with
externalProjectId externalProjectId string Id of the project in the external tool that is linked with the parent portfolio of this link
externalTaskId externalTaskId string Id of the task in the external tool that is associated with this link
externalName externalName string Name of the task in the external tool
externalUrl externalUrl string Url of the task in the external tool
externalStartDate externalStartDate date-time Start date of the task in the external tool
externalDueDate externalDueDate date-time Due date of the task in the external tool
refreshErrorCode refreshErrorCode integer Errorcode for refresh errors occuring during scheduled refresh
refreshError refreshError string Error description occuring during scheduled refresh

List of RoadmapItemLinks

Name Path Type Description
value value array of RoadmapItemLink An array of RoadmapItemLinks

Actions

Get PortfolioLink

This operation is used to retrieve the PortfolioLink associated with a portfolio in a Roadmap. This object contains information about the external project that this portfolio is linked to.

Get RoadmapItemLinks for a Portfolio

This operation is used to retrieve all the RoadmapItemLinks associated with a portfolio in a Roadmap. RoadmapItemLinks contain information about the external tasks that are imported in this portfolio.

Update PortfolioLink

This operation is used to update the PortfolioLink associated with a portfolio in a Roadmap.

Update RoadmapItemLink

This operation is used to update a RoadmapItemLink.

Get PortfolioLink

This operation is used to retrieve the PortfolioLink associated with a portfolio in a Roadmap. This object contains information about the external project that this portfolio is linked to.

Parameters

Name Key Required Type Description
Organization Name
organization True string

Name of Dynamics 365 organization like Contoso

Portfolio Id
portfolioid True guid

Id of the Portfolio connected to an external project

Returns

Object describing external project linkage information for a Portfolio

Get RoadmapItemLinks for a Portfolio

This operation is used to retrieve all the RoadmapItemLinks associated with a portfolio in a Roadmap. RoadmapItemLinks contain information about the external tasks that are imported in this portfolio.

Parameters

Name Key Required Type Description
Organization Name
organization True string

Name of Dynamics 365 organization like Contoso

Portfolio Id
portfolioid True guid

Id of the Portfolio connected to an external project

Returns

List of RoadmapItemLinks

Update PortfolioLink

This operation is used to update the PortfolioLink associated with a portfolio in a Roadmap.

Parameters

Name Key Required Type Description
Organization Name
organization True string

Name of Dynamics 365 organization like Contoso

Portfolio Id
portfolioid True guid

Id of the Portfolio connected to an external project

id
id string

Id of the PortfolioLink

portfolioItemId
portfolioItemId guid

Id of the portfolio item associated with this link

externalProjectId
externalProjectId string

Id of the project in the external tool

externalProjectName
externalProjectName string

Name of the project in the external tool

externalUrl
externalUrl string

Url of the project in the external tool

refreshErrorCode
refreshErrorCode integer

Errorcode for refresh errors occuring during scheduled refresh

refreshError
refreshError string

Error description occuring during scheduled refresh

refreshStartDate
refreshStartDate date-time

Latest refresh start time

refreshEndDate
refreshEndDate date-time

Latest refresh end time

refreshStatus
refreshStatus integer

Last refresh operation status

Returns

Object describing external project linkage information for a Portfolio

Update RoadmapItemLink

This operation is used to update a RoadmapItemLink.

Parameters

Name Key Required Type Description
Organization Name
organization True string

Name of Dynamics 365 organization like Contoso

Portfolio Id
portfolioid True guid

Id of the Portfolio connected to an external project

RoadmapItem Id
roadmapitemid True guid

Id of the RoadmapItem parent of the roadmap item link to be updated

id
id string

Id of the RoadmapItemLink

roadmapItemId
roadmapItemId string

Id of the parent roadmap item that this link is associated with

externalProjectId
externalProjectId string

Id of the project in the external tool that is linked with the parent portfolio of this link

externalTaskId
externalTaskId string

Id of the task in the external tool that is associated with this link

externalName
externalName string

Name of the task in the external tool

externalUrl
externalUrl string

Url of the task in the external tool

externalStartDate
externalStartDate date-time

Start date of the task in the external tool

externalDueDate
externalDueDate date-time

Due date of the task in the external tool

refreshErrorCode
refreshErrorCode integer

Errorcode for refresh errors occuring during scheduled refresh

refreshError
refreshError string

Error description occuring during scheduled refresh

Returns

Object describing external task linkage for a single item under a portfolio.

Definitions

PortfolioLink

Object describing external project linkage information for a Portfolio

Name Path Type Description
id
id string

Id of the PortfolioLink

portfolioItemId
portfolioItemId guid

Id of the portfolio item associated with this link

externalProjectId
externalProjectId string

Id of the project in the external tool

externalProjectName
externalProjectName string

Name of the project in the external tool

externalUrl
externalUrl string

Url of the project in the external tool

refreshErrorCode
refreshErrorCode integer

Errorcode for refresh errors occuring during scheduled refresh

refreshError
refreshError string

Error description occuring during scheduled refresh

refreshStartDate
refreshStartDate date-time

Latest refresh start time

refreshEndDate
refreshEndDate date-time

Latest refresh end time

refreshStatus
refreshStatus integer

Last refresh operation status

RoadmapItemLink

Object describing external task linkage for a single item under a portfolio.

Name Path Type Description
id
id string

Id of the RoadmapItemLink

roadmapItemId
roadmapItemId string

Id of the parent roadmap item that this link is associated with

externalProjectId
externalProjectId string

Id of the project in the external tool that is linked with the parent portfolio of this link

externalTaskId
externalTaskId string

Id of the task in the external tool that is associated with this link

externalName
externalName string

Name of the task in the external tool

externalUrl
externalUrl string

Url of the task in the external tool

externalStartDate
externalStartDate date-time

Start date of the task in the external tool

externalDueDate
externalDueDate date-time

Due date of the task in the external tool

refreshErrorCode
refreshErrorCode integer

Errorcode for refresh errors occuring during scheduled refresh

refreshError
refreshError string

Error description occuring during scheduled refresh

RoadmapItemLinks

List of RoadmapItemLinks

Name Path Type Description
value
value array of RoadmapItemLink

An array of RoadmapItemLinks