Connectors Reference
Project Roadmap Connector
|
Status: Preview |
Tier: Standard |
Version: 1.0 |
|
Name |
Summary |
|
Get PortfolioLink |
|
|
UpdatePortfolioLink (string organization, string portfolioid, PortfolioLink body) |
Update PortfolioLink |
|
GetRoadmapItemLinksForPortfolio (string organization, string portfolioid) |
Get RoadmapItemLinks for a Portfolio |
|
Update RoadmapItemLink |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
Summary: Get PortfolioLink
Description: 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.
Syntax:
ProjectRoadmap.GetPortfolioLink (string organization, string portfolioid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
organization |
string (Organization Name) |
Name of Dynamics 365 organization like Contoso |
True |
|
|
portfolioid |
string(guid) (Portfolio Id) |
Id of the Portfolio connected to an external project |
True |
Returns:
Type:PortfolioLink
Description: Object describing external project linkage information for a Portfolio
Summary: Update PortfolioLink
Description: This operation is used to update the PortfolioLink associated with a portfolio in a Roadmap.
Syntax:
ProjectRoadmap.UpdatePortfolioLink (string organization, string portfolioid, PortfolioLink body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
organization |
string (Organization Name) |
Name of Dynamics 365 organization like Contoso |
True |
|
|
portfolioid |
string(guid) (Portfolio Id) |
Id of the Portfolio connected to an external project |
True |
|
|
body |
|
Object describing external project linkage information for a Portfolio |
True |
Returns:
Type:PortfolioLink
Description: Object describing external project linkage information for a Portfolio
Summary: Get RoadmapItemLinks for a Portfolio
Description: 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.
Syntax:
ProjectRoadmap.GetRoadmapItemLinksForPortfolio (string organization, string portfolioid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
organization |
string (Organization Name) |
Name of Dynamics 365 organization like Contoso |
True |
|
|
portfolioid |
string(guid) (Portfolio Id) |
Id of the Portfolio connected to an external project |
True |
Returns:
Type:RoadmapItemLinks
Description: List of RoadmapItemLinks
Summary: Update RoadmapItemLink
Description: This operation is used to update a RoadmapItemLink.
Syntax:
ProjectRoadmap.UpdateRoadmapItemLink (string organization, string portfolioid, string roadmapitemid, RoadmapItemLink body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
organization |
string (Organization Name) |
Name of Dynamics 365 organization like Contoso |
True |
|
|
portfolioid |
string(guid) (Portfolio Id) |
Id of the Portfolio connected to an external project |
True |
|
|
roadmapitemid |
string(guid) (RoadmapItem Id) |
Id of the RoadmapItem parent of the roadmap item link to be updated |
True |
|
|
body |
|
Object describing external task linkage for a single item under a portfolio. |
True |
Returns:
Type:RoadmapItemLink
Description: Object describing external task linkage for a single item under a portfolio.
Summary:
Description: Object describing external project linkage information for a Portfolio
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Id of the PortfolioLink |
|
portfolioItemId |
string(guid)
|
Id of the portfolio item associated with this link |
|
externalProjectId |
string
|
Id of the project in the external tool |
|
externalProjectName |
string
|
Name of the project in the external tool |
|
externalUrl |
string
|
Url of the project in the external tool |
|
refreshErrorCode |
integer(int32)
|
Errorcode for refresh errors occuring during scheduled refresh |
|
refreshError |
string
|
Error description occuring during scheduled refresh |
|
refreshStartDate |
string(date-time)
|
Latest refresh start time |
|
refreshEndDate |
string(date-time)
|
Latest refresh end time |
|
refreshStatus |
integer(int32)
|
Last refresh operation status |
Summary:
Description: Object describing external task linkage for a single item under a portfolio.
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Id of the RoadmapItemLink |
|
roadmapItemId |
string
|
Id of the parent roadmap item that this link is associated with |
|
externalProjectId |
string
|
Id of the project in the external tool that is linked with the parent portfolio of this link |
|
externalTaskId |
string
|
Id of the task in the external tool that is associated with this link |
|
externalName |
string
|
Name of the task in the external tool |
|
externalUrl |
string
|
Url of the task in the external tool |
|
externalStartDate |
string(date-time)
|
Start date of the task in the external tool |
|
externalDueDate |
string(date-time)
|
Due date of the task in the external tool |
|
refreshErrorCode |
integer(int32)
|
Errorcode for refresh errors occuring during scheduled refresh |
|
refreshError |
string
|
Error description occuring during scheduled refresh |
Summary:
Description: List of RoadmapItemLinks
Properties:
|
Name |
Type |
Summary |
|
value |
array of (RoadmapItemLink)
|
An array of RoadmapItemLinks |