businessScenarioTask resource type
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 plannerTask that is associated with a businessScenario and contains additional scenario data.
Inherits from plannerTask.
Methods
| Method | Return type | Description |
|---|---|---|
| List | businessScenarioTask collection | Get a list of the businessScenarioTask objects and their properties. |
| Create | businessScenarioTask | Create a new businessScenarioTask object. |
| Get | businessScenarioTask | Read the properties and relationships of a businessScenarioTask object. |
| Update | businessScenarioTask | Update the properties of a businessScenarioTask object. |
| Delete | None | Delete a businessScenarioTask object. |
Properties
| Property | Type | Description |
|---|---|---|
| activeChecklistItemCount | Int32 | Number of checklist items with value set to false, representing incomplete items. Inherited from plannerTask. |
| appliedCategories | plannerAppliedCategories | The categories to which the task has been applied. For possible values, see plannerAppliedCategories. Inherited from plannerTask. |
| assigneePriority | String | Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner. Inherited from plannerTask. |
| assignments | plannerAssignments | The set of assignees the task is assigned to. Inherited from plannerTask. |
| bucketId | String | Bucket ID to which the task belongs. Inherited from plannerTask. |
| businessScenarioProperties | businessScenarioProperties | Scenario-specific properties of the task. externalObjectId and externalBucketId properties must be specified when creating a task. |
| checklistItemCount | Int32 | Number of checklist items that are present on the task. Inherited from plannerTask. |
| completedBy | identitySet | Identity of the user who completed the task. Inherited from plannerTask. Read-Only. |
| completedDateTime | DateTimeOffset | Date and time at which the percentComplete of the task is set to 100. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from plannerTask. Read-only. |
| conversationThreadId | String | Thread ID of the conversation on the task. This property contains the ID of the conversation thread object created in the group. Inherited from plannerTask. |
| createdBy | identitySet | Identity of the user who created the task. Inherited from plannerTask. Read-Only. |
| createdDateTime | DateTimeOffset | Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Inherited from plannerTask. Read-only. |
| creationSource | plannerTaskCreation | Contains information about the origin of the task. Inherited from plannerTask. |
| dueDateTime | DateTimeOffset | Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from plannerTask. |
| hasDescription | Boolean | True indicates that the details object of the task has a nonempty description; otherwise, false. Inherited from plannerTask. Read-only. |
| id | String | The unique identifier for the task. Inherited from entity. Read-only. |
| orderHint | String | Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner. Inherited from plannerTask. |
| percentComplete | Int32 | Percentage of task completion. When set to 100, the task is considered completed. Inherited from plannerTask. |
| planId | String | Identifier of the plan to which the task belongs. Inherited from plannerTask. |
| previewType | plannerPreviewType | This sets the type of preview that shows up on the task. Possible values are: automatic, noPreview, checklist, description, reference. Inherited from plannerTask. |
| priority | Int32 | Priority of the task. Valid range of values is between 0 and 10 (inclusive), with increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as "urgent", 2, 3, and 4 as "important", 5, 6, and 7 as "medium", and 8, 9, and 10 as "low". Currently, Planner sets the value 1 for "urgent", 3 for "important", 5 for "medium", and 9 for "low". Inherited from plannerTask. |
| referenceCount | Int32 | Number of external references that exist on the task. Inherited from plannerTask. |
| startDateTime | DateTimeOffset | Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from plannerTask. |
| target | businessScenarioTaskTargetBase | Target of the task that specifies where the task should be placed. Must be specified when creating a task. |
| title | String | Title of the task. Inherited from plannerTask. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| assignedToTaskBoardFormat | plannerAssignedToTaskBoardTaskFormat | Used to render the task correctly in the task board view when grouped by assignedTo. Inherited from plannerTask. |
| bucketTaskBoardFormat | plannerBucketTaskBoardTaskFormat | Used to render the task correctly in the task board view when grouped by bucket. Inherited from plannerTask. |
| details | plannerTaskDetails | Additional details about the task. Inherited from plannerTask. |
| progressTaskBoardFormat | plannerProgressTaskBoardTaskFormat | Used to render the task correctly in the task board view when grouped by progress. Inherited from plannerTask. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.businessScenarioTask",
"activeChecklistItemCount": "Int32",
"appliedCategories": {"@odata.type": "microsoft.graph.plannerAppliedCategories"},
"assigneePriority": "String",
"assignments": {"@odata.type": "microsoft.graph.plannerAssignments"},
"bucketId": "String",
"businessScenarioProperties": {"@odata.type": "microsoft.graph.businessScenarioProperties"},
"checklistItemCount": "Int32",
"completedBy": {"@odata.type": "microsoft.graph.identitySet"},
"completedDateTime": "String (timestamp)",
"conversationThreadId": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"creationSource": {"@odata.type": "microsoft.graph.plannerTaskCreation"},
"dueDateTime": "String (timestamp)",
"hasDescription": "Boolean",
"id": "String (identifier)",
"orderHint": "String",
"percentComplete": "Int32",
"planId": "String",
"previewType": "String",
"priority": "Int32",
"referenceCount": "Int32",
"startDateTime": "String (timestamp)",
"target": {"@odata.type": "microsoft.graph.businessScenarioTaskTargetBase"},
"title": "String"
}