EntityType: Issue (ProjectData service)
In this article
Definition
Parent element
Child elements
Contains the properties that define the reporting data for an issue in the ProjectData service.
Example
The following REST query uses the Issues entity set and the ProjectId key to get the issues for the specified project. The query is all on one line.
http://<pwa_url>/_api/ProjectData/Issues
?$filter=ProjectId eq guid'4fbb36d6-97bc-e111-a7e3-00155d4a5608'
Definition
<EntityType Name="Issue">
<Key>
<PropertyRef Name="ProjectId" />
<PropertyRef Name="IssueId" />
</Key>
<Property Name="ProjectId" Type="Edm.Guid" Nullable="false" />
. . .
<NavigationProperty Name="AffectedTasks" Relationship="ReportingData.Issue_AffectedTasks" ToRole="AffectedTasks" FromRole="Issue" />
. . .
</EntityType>
Parent element
Element |
Description |
|---|---|
The schema for the reporting data in the ProjectData service. |
Child elements
Child elements are properties of an issue and navigation properties of that issue. 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 tasks and projects, that are associated with an issue. 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 an issue query. ProjectId is the project GUID and IssueId is the GUID of the issue.
Property elements
The following table lists the values of the Property elements for the Issue entity. The Name, Type, and Nullable columns contain attribute values for each property.
Attribute values for the Property elements of Issue
Name |
Type |
Nullable |
Description |
|---|---|---|---|
AssignedToResource |
Edm.String |
true |
The resource to which the issue is assigned. |
Category |
Edm.String |
true |
The category of the issue. |
CreateByResource |
Edm.String |
true |
The resource that created the issue. |
CreatedDate |
Edm.DateTime |
true |
The date and time of creation of the issue. |
Discussion |
Edm.String |
true |
The text field for the issue discussion. |
DueDate |
Edm.DateTime |
true |
The due date and time of the issue. |
IsFolder |
Edm.Boolean |
false |
True if the issue is a folder in the SharePoint list. |
IssueId |
Edm.Guid |
false |
Key |
ItemRelativeUrlPath |
Edm.String |
true |
The relative URL of the issue. |
ModifiedByResource |
Edm.String |
true |
The user who last modified the issue. |
ModifiedDate |
Edm.DateTime |
true |
The date and time that the issue was last modified. |
NumberOfAttachments |
Edm.Int32 |
true |
The number of attachments for the issue. |
Owner |
Edm.String |
true |
The owner of the issue. |
Priority |
Edm.String |
true |
The priority of the issue. |
ProjectId |
Edm.Guid |
false |
Key |
ProjectName |
Edm.String |
true |
The name of the project. |
Resolution |
Edm.String |
true |
The resolution of the issue. |
Status |
Edm.String |
true |
The status of the issue. |
Title |
Edm.String |
true |
The title or name of the issue. |
NavigationProperty elements
The following table lists attribute values for the NavigationProperty elements of the Issue 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 Issue. For this type of navigation, the FromRole is Project_Issues, and the ToRole is Issue_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 AffectedTasks navigation property relationship, Issue is the primary entity type and AffectedTasks is the secondary entity type.
Attribute values for the NavigationProperty elements
Name |
Relationship |
Description |
|---|---|---|
Project |
Establishes navigation from a project to a collection of issues and from an issues to a project. |
|
RelatedRisks |
Establishes navigation from a collection of issues to a collection of related risks and from a risk to a collection of related issues. |
|
Tasks |
Issue_Tasks_Task_Issues |
Establishes navigation from a collection of issues to a task and from a task to a collection of issues. |
SubIssues |
Establishes navigation from a collection of issues to a subissue. |