EntityType: BusinessDriver (ProjectData service)

In this article
Definition
Parent element
Child elements

Contains the properties that define the reporting data for a business driver in the ProjectData service.

Example

The following REST query uses the BusinessDrivers entity set and the BusinessDriverIsActive property to get the specified properties for active business drivers in ProjectData. The query is all on one line.

https://<pwa_url>/_api/ProjectData/BusinessDrivers
    ?$filter=BusinessDriverIsActive eq true
    &$select=BusinessDriverName,BusinessDriverDescription

Definition

<EntityType Name="BusinessDriver">
  <Key>
    <PropertyRef Name="BusinessDriverId" />
  </Key>
  <Property Name="BusinessDriverId" Type="Edm.Guid" Nullable="false" />
  . . .
  <NavigationProperty Name="CreatedByResource" Relationship="ReportingData.BusinessDriver_CreatedByResource" ToRole="CreatedByResource" FromRole="BusinessDriver" />
  . . .
</EntityType>

Parent element

Element	Description
ReportingData	The schema for the reporting data in the ProjectData service.

Child elements

Child elements are properties of a business driver and navigation properties of that business driver. 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 departments, that are associated with a business driver. 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 business driver query. BusinessDriverId is the business driver GUID.

Property elements

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

Attribute values for the Property elements of BusinessDriver

Name	Type	Nullable	Description
BusinessDriverCreatedDate	Edm.DateTime	false	The date and time of the creation of a business goal, also known as a business driver.
BusinessDriverDescription	Edm.String	true	The description of a business driver.
BusinessDriverId	Edm.Guid	false	Key The GUID that identifies a business driver.
BusinessDriverIsActive	Edm.Boolean	false	True if a business driver is active.
BusinessDriverModifiedDate	Edm.DateTime	false	The date and time that a business driver was last modified.
BusinessDriverName	Edm.String	true	The name of a business driver.
CreatedByResourceId	Edm.Guid	true	The GUID of the resource that created the business driver.
CreatedByResourceName	Edm.String	true	The name of the resource that created the driver.
ImpactDescriptionExtreme	Edm.String	true	The description of risk occurrence impact when the magnitude of the impact is extreme.
ImpactDescriptionLow	Edm.String	true	The description of risk occurrence impact when the magnitude of the impact is low.
ImpactDescriptionModerate	Edm.String	true	The description of risk occurrence impact when the magnitude of the impact is moderate.
ImpactDescriptionNone	Edm.String	true	The description of risk occurrence impact when the magnitude of the impact is nonexistent.
ImpactDescriptionStrong	Edm.String	true	The description of risk occurrence impact when the magnitude of the impact is strong.
ModifiedByResourceId	Edm.Guid	true	The GUID of the resource that last updated the business driver.
ModifiedByResourceName	Edm.String	true	The name of the resource that last modified the driver.

NavigationProperty elements

The following table lists attribute values for the NavigationProperty elements of the BusinessDriver 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 Departments navigation property, the primary type is BusinessDriver, and the secondary type is BusinessDriverDepartment. For this type of navigation, the FromRole is BusinessDriver_Departments, and the ToRole is BusinessDriverDepartment_BusinessDriver.

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, BusinessDriver is the primary entity type and CreatedByResource is the secondary entity type.

Attribute values for the NavigationProperty elements

Name	Relationship	Description
CreatedByResource	BusinessDriver_CreatedByResource	Establishes navigation from a collection of business drivers to the resource that created the business driver.
Departments	BusinessDriver_Departments_BusinessDriverDepartment_BusinessDriver	Establishes navigation from a business driver to a collection of business driver departments and from a business driver department to a business driver.
ModifiedByResource	BusinessDriver_ModifiedByResource	Establishes navigation from a collection of business drivers to the resource that modified the business driver.

See also

Reference

BusinessDrivers

ReportingData

Concepts

Querying OData feeds for Project 2013 reporting data