Expand Minimize

EntityType: Deliverable (ProjectData service)

Office 2013

Last modified: August 07, 2014

In this article
Definition
Parent element
Child elements

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

The following REST query uses the Deliverables entity set and the DeliverableId and ProjectId keys to get the URL path of the specified deliverable. The query is all on one line.

http://<pwa_url>/_api/ProjectData/Deliverables
    ?$select=ItemRelativeUrlPath
    &$filter=DeliverableId eq guid'ff5ab774-4dff-4af7-a0d9-f0214c782d86'
    and ProjectId eq guid'c03bfc61-e0e1-e111-8d29-00155d35d32e'

<EntityType Name="Deliverable">
  <Key>
    <PropertyRef Name="ProjectId" />
    <PropertyRef Name="DeliverableId" />
  </Key>
  <Property Name="ProjectId" Type="Edm.Guid" Nullable="false" />
  . . .
  <NavigationProperty Name="DependentProjects" Relationship="ReportingData.Project_Dependencies_Deliverable_DependentProjects" ToRole="Project_Dependencies" FromRole="Deliverable_DependentProjects" />
  . . .
</EntityType>

Element

Description

ReportingData

The schema for the reporting data in the ProjectData service.

Child elements are properties of a deliverable and navigation properties of that deliverable. 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 parent projects and dependent tasks, that are associated with a deliverable. A navigation property uses an Association element in a query for a related entity or collection

The Key elements specify the properties that are the primary keys for a deliverable query. ProjectId is the project GUID and DeliverableId is the GUID of the deliverable.

Property elements

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

Attribute values for the Property elements of Deliverables

Name

Type

Nullable

Description

CreateByResource

Edm.String

true

The resource that created the deliverable.

CreatedDate

Edm.DateTime

true

The date and time that the deliverable was created.

DeliverableId

Edm.Guid

false

Key
The GUID of the deliverable.

Description

Edm.String

true

The description of the deliverable.

FinishDate

Edm.DateTime

true

The finish date of the deliverable.

IsFolder

Edm.Boolean

false

True if the deliverable is a folder in the SharePoint list.

ItemRelativeUrlPath

Edm.String

true

The relative URL of the deliverable.

ModifiedByResource

Edm.String

true

The resource that last changed the deliverable.

ModifiedDate

Edm.DateTime

true

The date and time that the deliverable was modified.

ProjectId

Edm.Guid

false

Key
The GUID of the project for the deliverable.

ProjectName

Edm.String

true

The name of the project.

StartDate

Edm.DateTime

true

The start date and time of the deliverable.

Title

Edm.String

true

The title of the deliverable.

NavigationProperty elements

The following table lists attribute values for the NavigationProperty elements of the Deliverable 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 Project navigation property, the primary type is Project, and the secondary type is Deliverable. For this type of navigation, the FromRole is Project_Deliverables, and the ToRole is Deliverable_Project.

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 DependentTasks navigation property relationship, Deliverable is the primary entity type and DependentTasks is the secondary entity type.

Attribute values for the NavigationProperty elements

Name

Relationship

Description

DependentProjects

Project_Dependencies_Deliverable_DependentProjects

Establishes navigation from a collection of projects to a dependenciy entity and from a deliverable to a collection of dependent projects.

DependentTasks

Deliverable_DependentTasks

Establishes navigation from a collection of deliverables to a dependent task.

ParentProjects

Deliverable_ParentProjects

Establishes navigation from a collection of deliverables to a parent project.

ParentTasks

Deliverable_ParentTasks

Establishes navigation from a collection of deliverables to a task.

Project

Project_Deliverables_Deliverable_Project

Establishes navigation from a project to a collection of deliverables and from deliverable to a project.

Show:
© 2014 Microsoft