Skip to content

Commit 7db438d

Browse files
committed
Update List Tasks in Business Scenario to require one filter, update example for group id, add example for external object id filter, and remove example that has no filters
1 parent bbd36a0 commit 7db438d

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

api-reference/beta/api/businessscenarioplanner-list-tasks.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ Choose the permission or permissions marked as least privileged for this API. Us
3333
GET /solutions/businessScenarios/{businessScenarioId}/planner/tasks
3434
```
3535

36-
## Optional query parameters
36+
## Required query parameters
3737

38-
This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). You can query tasks with their context ID or location as filters.
38+
This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). You must query tasks with one of their Object ID, Context ID or Group ID as filters.
3939

4040
## Request headers
4141

@@ -53,9 +53,9 @@ If successful, this method returns a `200 OK` response code and a collection of
5353

5454
## Examples
5555

56-
### Example 1: Get all tasks for a scenario
56+
### Example 1: Get tasks associated with a specific externalObjectId
5757

58-
The following example shows a request that gets all tasks related to a scenario.
58+
The following example shows a request that gets all tasks associated with a specific context.
5959

6060
#### Request
6161

@@ -64,44 +64,44 @@ The following example shows a request.
6464
# [HTTP](#tab/http)
6565
<!-- {
6666
"blockType": "request",
67-
"name": "list_businessscenariotask_e1",
67+
"name": "list_businessscenariotask_e2",
6868
"sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"]
6969
}
7070
-->
7171
``` http
72-
GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks
72+
GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks?$filter=businessScenarioProperties/externalObjectId eq 'Order#12010'
7373
```
7474

7575
# [C#](#tab/csharp)
76-
[!INCLUDE [sample-code](../includes/snippets/csharp/list-businessscenariotask-e1-csharp-snippets.md)]
76+
[!INCLUDE [sample-code](../includes/snippets/csharp/list-businessscenariotask-e2-csharp-snippets.md)]
7777
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
7878

7979
# [CLI](#tab/cli)
80-
[!INCLUDE [sample-code](../includes/snippets/cli/list-businessscenariotask-e1-cli-snippets.md)]
80+
[!INCLUDE [sample-code](../includes/snippets/cli/list-businessscenariotask-e2-cli-snippets.md)]
8181
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
8282

8383
# [Go](#tab/go)
84-
[!INCLUDE [sample-code](../includes/snippets/go/list-businessscenariotask-e1-go-snippets.md)]
84+
[!INCLUDE [sample-code](../includes/snippets/go/list-businessscenariotask-e2-go-snippets.md)]
8585
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
8686

8787
# [Java](#tab/java)
88-
[!INCLUDE [sample-code](../includes/snippets/java/list-businessscenariotask-e1-java-snippets.md)]
88+
[!INCLUDE [sample-code](../includes/snippets/java/list-businessscenariotask-e2-java-snippets.md)]
8989
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
9090

9191
# [JavaScript](#tab/javascript)
92-
[!INCLUDE [sample-code](../includes/snippets/javascript/list-businessscenariotask-e1-javascript-snippets.md)]
92+
[!INCLUDE [sample-code](../includes/snippets/javascript/list-businessscenariotask-e2-javascript-snippets.md)]
9393
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
9494

9595
# [PHP](#tab/php)
96-
[!INCLUDE [sample-code](../includes/snippets/php/list-businessscenariotask-e1-php-snippets.md)]
96+
[!INCLUDE [sample-code](../includes/snippets/php/list-businessscenariotask-e2-php-snippets.md)]
9797
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
9898

9999
# [PowerShell](#tab/powershell)
100-
[!INCLUDE [sample-code](../includes/snippets/powershell/list-businessscenariotask-e1-powershell-snippets.md)]
100+
[!INCLUDE [sample-code](../includes/snippets/powershell/list-businessscenariotask-e2-powershell-snippets.md)]
101101
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
102102

103103
# [Python](#tab/python)
104-
[!INCLUDE [sample-code](../includes/snippets/python/list-businessscenariotask-e1-python-snippets.md)]
104+
[!INCLUDE [sample-code](../includes/snippets/python/list-businessscenariotask-e2-python-snippets.md)]
105105
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
106106

107107
---
@@ -129,16 +129,16 @@ Content-Type: application/json
129129
"priority": 5,
130130
"id": "pmc1rS1Io0C3rXQhyXIsNmUAOeIi",
131131
"target": {
132-
"@odata.type": "microsoft.graph.businessScenarioGroupTarget",
133-
"taskTargetKind": "group",
134-
"groupId": "7a339254-4b2b-4410-b295-c890a16776ee"
132+
"@odata.type": "microsoft.graph.businessScenarioGroupTarget",
133+
"taskTargetKind": "group",
134+
"groupId": "7a339254-4b2b-4410-b295-c890a16776ee"
135135
},
136136
"businessScenarioProperties": {
137-
"externalObjectId": "Order#12010",
138-
"externalContextId": "Warehouse-CA-36",
139-
"externalObjectVersion": "000001",
140-
"webUrl": "https://ordertracking.contoso.com/view?id=12010",
141-
"externalBucketId": "deliveryBucket"
137+
"externalObjectId": "Order#12010",
138+
"externalContextId": "Warehouse-CA-36",
139+
"externalObjectVersion": "000001",
140+
"webUrl": "https://ordertracking.contoso.com/view?id=12010",
141+
"externalBucketId": "deliveryBucket"
142142
}
143143
}
144144
]
@@ -253,7 +253,7 @@ The following example shows a request.
253253
}
254254
-->
255255
``` http
256-
GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks?$filter=location/microsoft.graph.businessScenarioGroupTarget/groupId eq '7a339254-4b2b-4410-b295-c890a16776ee'
256+
GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks?$filter=target/microsoft.graph.businessScenarioGroupTarget/groupId eq '7a339254-4b2b-4410-b295-c890a16776ee'
257257
```
258258

259259
# [C#](#tab/csharp)

0 commit comments

Comments
 (0)