Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a goal in the Planner Unified plans Graph API within a plan, including its name, status, dates, priority, and notes. See the status property for the supported status values.
Inherits from plannerDelta.
Methods
| Method | Return type | Description |
|---|---|---|
| List | goal collection | Get a list of the goal objects and their properties. |
| Get | goal | Read the properties and relationships of goal object. |
| List tasks | task collection | Get a list of the task objects and their properties. |
Properties
| Property | Type | Description |
|---|---|---|
| archivalInfo | plannerArchivalInfo | Information about whether the entity is archived, and when it was archived. |
| capabilities | goalCapability | Server-computed, read-only capability flags indicating which optional features are enabled for the entity. |
| createdBy | identitySet | Identity of the user (or application) who created the entity. Read-only. |
| createdDateTime | DateTimeOffset | Date and time the entity was created. The value is represented in ISO 8601 format and is always in UTC time. Read-only. |
| displayName | String | Title of the goal. |
| extensions | extensionFieldCollection | Custom extension field values set on the entity. Supports $select. |
| finishDate | Date | Date the goal is targeted to finish. |
| id | String | The unique identifier of the entity. Read-only. Inherited from entity |
| lastModifiedBy | identitySet | Identity of the user (or application) who last modified the entity. Read-only. |
| lastModifiedDateTime | DateTimeOffset | Date and time the entity was last modified. The value is represented in ISO 8601 format and is always in UTC time. Read-only. |
| notes | itemBody | Additional details or notes about the goal. |
| planId | String | ID of the plan that contains the goal. Immutable after creation. |
| priority | Int32 | Priority of the goal. |
| startDate | Date | Date the goal starts. |
| status | plannerGoalStatus | Progress status of the goal. The possible values are: notStarted, onTrack, behind, atRisk, closed, unknownFutureValue. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| tasks | task collection | The collection of tasks associated with the goal. Read-only. Nullable. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.goal",
"id": "String (identifier)",
"displayName": "String",
"planId": "String",
"status": "String",
"priority": "Int32",
"startDate": "Date",
"finishDate": "Date",
"notes": {
"@odata.type": "microsoft.graph.itemBody"
},
"archivalInfo": {
"@odata.type": "microsoft.graph.plannerArchivalInfo"
},
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"createdDateTime": "String (timestamp)",
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "String (timestamp)",
"capabilities": {
"@odata.type": "microsoft.graph.goalCapability"
},
"extensions": {
"@odata.type": "microsoft.graph.extensionFieldCollection"
}
}