Collapse the table of content
Expand the table of content
Expand Minimize

EntityType: PortfolioAnalysis (ProjectData service)

Office 2013

Last modified: March 09, 2015

In this article
Definition
Parent element
Child elements

Contains the properties that define the reporting data for a portfolio analysis in the ProjectData service.

The following REST query uses the PortfolioAnalyses entity set and the DepartmentId property to get portfolio analysis information for the specified department. The query is all on one line.

http://<pwa_url>/_api/ProjectData/PortfolioAnalyses
    ?$filter=DepartmentId eq guid'18b25c88-86a4-e111-9719-00155db24e18'
    &$select=AnalysisId,AnalysisName,AnalysisDescription,HardConstraintCustomFieldName

<EntityType Name="PortfolioAnalysis">
  <Key>
    <PropertyRef Name="AnalysisId" />
  </Key>
  <Property Name="AnalysisId" Type="Edm.Guid" Nullable="false" />
  . . .
  <NavigationProperty Name="CreatedByResource" Relationship="ReportingData.PortfolioAnalysis_CreatedByResource" ToRole="CreatedByResource" FromRole="PortfolioAnalysis" />
  . . .
</EntityType>

Element

Description

ReportingData

The schema for the reporting data in the ProjectData service.

Child elements are properties of a portfolio analysis and navigation properties of that portfolio analysis. Attributes of the Property elements specify the property name and type, and whether the property can be a null value. The NavigationProperty elements specify collections of entities, such as analysis projects and prioritization, that are associated with a portfolio analysis. A navigation property uses an Association element in a query for a related entity or collection

The Key element specifies the property that is the primary key for a project query. AnalysisId is the portfolio analysis GUID.

Property elements

The following table lists the values of the Property elements for the PortfolioAnalysis entity. The Name, Type, and Nullable columns contain attribute values for each property.

Attribute values for the Property elements of PortfolioAnalysis

Name

Type

Nullable

Description

AlternateProjectEndDateCustomFieldId

Edm.Guid

true

The GUID for a custom field that contains an alternate end date and time for a portfolio analysis.

AlternateProjectEndDateCustomFieldName

Edm.String

true

The name of a custom field that contains an alternate end date and time for a portfolio analysis.

AlternateProjectStartDateCustomFieldId

Edm.Guid

true

The GUID for a custom field that contains an alternate start date for a portfolio analysis.

AlternateProjectStartDateCustomFieldName

Edm.String

true

The name of a custom field that contains an alternate start date for a portfolio analysis.

AnalysisDescription

Edm.String

true

The text description for a portfolio analysis.

AnalysisId

Edm.Guid

false

Key
The GUID for a portfolio analysis.

AnalysisName

Edm.String

true

The name of a portfolio analysis.

AnalysisType

Edm.Int32

false

The type of a portfolio analysis.

BookingType

Edm.Byte

false

The assignment booking type (committed or proposed).

CreatedByResourceId

Edm.Guid

true

The GUID of the resource that created a portfolio analysis.

CreatedByResourceName

Edm.String

true

The name of the resource that created a portfolio analysis.

CreatedDate

Edm.DateTime

false

The date and time that a portfolio analysis was created.

DepartmentId

Edm.Guid

true

The GUID of a department in a portfolio analysis.

DepartmentName

Edm.String

true

The name of a department in a portfolio analysis.

FilterResourcesByDepartment

Edm.Boolean

true

True if resources are filtered by departments.

FilterResourcesByRBS

Edm.Boolean

true

True if resources are filtered by Resource Breakdown Structure (RBS).

FilterResourcesByRBSValueId

Edm.Guid

true

The GUID of the RBS value that is used to filter resources.

FilterResourcesByRBSValueText

Edm.String

true

The RBS text value that is used to filter resources.

ForcedInAliasLookupTableId

Edm.Guid

true

The GUID of the lookup table that is used for forced-in aliasing.

ForcedInAliasLookupTableName

Edm.String

true

The name of the lookup table that is used for forced-in aliasing.

ForcedOutAliasLookupTableId

Edm.Guid

true

The GUID of the lookup table that is used for forced-out aliasing.

ForcedOutAliasLookupTableName

Edm.String

true

The name of the lookup table that is used for forced-out aliasing.

HardConstraintCustomFieldId

Edm.Guid

false

The GUID of the value that represents the sum of the primary constraint custom field values of projects selected in the optimizer.

HardConstraintCustomFieldName

Edm.String

true

The name of the value that represents the sum of the primary constraint custom field values of projects selected in the optimizer.

ModifiedByResourceId

Edm.Guid

true

The GUID of the resource that last updated a portfolio analysis.

ModifiedByResourceName

Edm.String

true

The name of the resource that last updated a portfolio analysis.

ModifiedDate

Edm.DateTime

false

The date and time when a portfolio analysis was modified.

PlanningHorizonEndDate

Edm.DateTime

true

The end of the date and time range that is considered in a portfolio analysis.

PlanningHorizonStartDate

Edm.DateTime

true

The beginning of the date and time range that is considered in a portfolio analysis.

PrioritizationId

Edm.Guid

true

The GUID for a portfolio analysis prioritization.

PrioritizationName

Edm.String

true

The name of a portfolio analysis prioritization.

PrioritizationType

Edm.Int32

false

The numerical value that represents the type of a portfolio analysis prioritization.

RoleCustomFieldId

Edm.Guid

true

The GUID of the custom field that is used to define a role.

RoleCustomFieldName

Edm.String

true

The name of the custom field that is used to define a role.

TimeScale

Edm.Byte

false

The scale of the timephased data.

UseAlternateProjectDatesForResourcePlans

Edm.Boolean

true

True if alternate project dates are used for resource plans.

NavigationProperty elements

The following table lists attribute values for the NavigationProperty elements of the PortfolioAnalysis entity. The Name and Relationship columns contain attribute values for each navigation property.There are two types of Relationship attributes. One type contains two pairs of names; each pair of names indicates a navigation direction. The first pair starts with the entity type that has the primary, or starting, role in the navigation. The second pair starts with the entity type that has the secondary, or dependent, role in the navigation. For example, for the AnalysisProjects navigation property, the primary type is PortfolioAnalysis, and the secondary type is PortfolioAnalysisProject. For this type of navigation, the FromRole is PortfolioAnalysis_AnalysisProjects, and the ToRole is PortfolioAnalysisProject_Analysis.

The other type of Relationship attribute contains a single pair of names. The first name in the pair is the primary entity type in the navigation. The second name in the pair is the secondary entity type in the navigation. For example, in the CreatedByResource navigation property relationship, PortfolioAnalysis is the primary entity type and CreatedByResource is the secondary entity type.

Attribute values for the NavigationProperty elements

Name

Relationship

Description

AnalysisProjects

PortfolioAnalysis_AnalysisProjects_PortfolioAnalysisProject_Analysis

Establishes navigation from a portfolio analyses to a collection of portfolio analysis projects and from a portfolio analysis project to a portfolio analysis.

CostConstraintScenarios

PortfolioAnalysis_CostConstraintScenarios_CostConstraintScenario_Analysis

Establishes navigation from a portfolio analyses to a collection of cost constraint scenarios and from a cost constraint scenario to a portfolio analysis.

CreatedByResource

PortfolioAnalysis_CreatedByResource

Establishes navigation from a collection of portfolio analyses to a resource.

ModifiedByResource

PortfolioAnalysis_ModifiedByResource

Establishes navigation from a collection of portfolio analyses to a resource.

Prioritization

PortfolioAnalysis_Prioritization

Establishes navigation from a collection of portfolio analyses to a prioritization.

ResourceConstraintScenarios

PortfolioAnalysis_ResourceConstraintScenarios_ResourceConstraintScenario_Analysis

Establishes navigation from a portfolio analyses to a collection of resource constraint scenarios and from a resource constraint scenario to a portfolio analysis.

Show:
© 2015 Microsoft