GET api/workplan/{id}/tasks?HasUpdates={HasUpdates}&FilterField={FilterField}&FilterValue={FilterValue}&BuiltInField={BuiltInField}
Get tasks for a plan
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| HasUpdates | boolean |
None. |
|
| FilterField | string |
Default value is |
|
| FilterValue | string |
Default value is |
|
| BuiltInField | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of WorkPlanTask| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkTypeId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Created | date |
None. |
|
| Modified | date |
None. |
|
| Author | string |
None. |
|
| Editor | string |
None. |
|
| AssignedTo | Collection of globally unique identifier |
None. |
|
| NonLaborAssignments | Collection of TaskNonLaborAssignment |
None. |
|
| Assignments | Collection of TaskAssignment |
None. |
|
| ParentId | globally unique identifier |
None. |
|
| WorkTypeParentId | globally unique identifier |
None. |
|
| WorkTypeIndex | integer |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| Index | integer |
None. |
|
| Complete | boolean |
None. |
|
| Comments | Collection of TaskComment |
None. |
|
| StartDate | date |
None. |
|
| DueDate | date |
None. |
|
| TaskScheduleType | TaskType |
None. |
|
| StatusUpdate | StatusUpdateClass |
None. |
|
| LastComment | date |
None. |
|
| IsScheduled | boolean |
None. |
|
| Integration | TaskIntegrationInfo |
None. |
|
| LinkedFileIds | Collection of string |
None. |
|
| LinkedLinkIds | Collection of string |
None. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"WorkTypeId": "ec71ba84-4769-4d0a-8e44-a50c78eb6045",
"Name": "sample string 1",
"Created": "2026-06-05T16:18:07.5485312+00:00",
"Modified": "2026-06-05T16:18:07.5485312+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1125ff9b-a1a6-40ff-9780-51caff4c0e38",
"aec86b59-cf14-48d1-ba50-670b0ced2eb8"
],
"NonLaborAssignments": [
{
"Id": "d51953c4-9e38-4d52-88ae-b5eb191585f0",
"ResourceId": "85d5d7c5-b63a-44fa-9e0e-aec9926836c9",
"Quantity": 3.0
},
{
"Id": "d51953c4-9e38-4d52-88ae-b5eb191585f0",
"ResourceId": "85d5d7c5-b63a-44fa-9e0e-aec9926836c9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3796f4dd-e757-450d-a031-75ddd9e404fc",
"Type": 0,
"ResourceId": "6afd0a80-d4d2-49b3-b9c0-7561147533af",
"Units": 3.0
},
{
"Id": "3796f4dd-e757-450d-a031-75ddd9e404fc",
"Type": 0,
"ResourceId": "6afd0a80-d4d2-49b3-b9c0-7561147533af",
"Units": 3.0
}
],
"ParentId": "c7c38412-bc25-43d4-9a97-2c14969086c2",
"WorkTypeParentId": "de32d548-e6fd-4049-9033-05e8d8927a40",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c8524a7f-e82a-4bad-98e7-043aef45cba1",
"UPN": "920d3d15-ac79-4e7f-ac88-dcc7965c883f",
"PostDate": "2026-06-05T16:18:07.5485312+00:00",
"Comment": "sample string 4",
"CC": [
"410f2833-e5cd-4239-a723-3b81b7294671",
"c5d54cfb-d832-48f2-9883-653a48db09e7"
],
"Users": [
"3f211283-6940-431e-8a04-9d2cc87ca45a",
"99e1d5c4-cdc3-4041-adaf-fe9c6b2d82c3"
]
},
{
"Id": "c8524a7f-e82a-4bad-98e7-043aef45cba1",
"UPN": "920d3d15-ac79-4e7f-ac88-dcc7965c883f",
"PostDate": "2026-06-05T16:18:07.5485312+00:00",
"Comment": "sample string 4",
"CC": [
"410f2833-e5cd-4239-a723-3b81b7294671",
"c5d54cfb-d832-48f2-9883-653a48db09e7"
],
"Users": [
"3f211283-6940-431e-8a04-9d2cc87ca45a",
"99e1d5c4-cdc3-4041-adaf-fe9c6b2d82c3"
]
}
],
"StartDate": "2026-06-05T16:18:07.5485312+00:00",
"DueDate": "2026-06-05T16:18:07.5485312+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"a3a2873d-6d36-49a1-9477-825dfc17f66e": "47973a14-d993-4df8-8e63-10be1246883f",
"c716bd78-aeed-4a22-94ab-7414599e454e": "3df6a190-65d0-4196-ae0e-72f558630e33"
},
"HasUpdates": true,
"Modified": "2026-06-05T16:18:07.5485312+00:00",
"Editor": "sample string 3",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"CalcFields": {
"sample string 1": {},
"sample string 3": {}
},
"State": 0,
"ApproveRejectBy": "sample string 4",
"ApproveRejectDate": "2026-06-05T16:18:07.5485312+00:00"
},
"LastComment": "2026-06-05T16:18:07.5485312+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3e5b9df0-5db2-4f0a-b114-8a8e0415816f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"LinkedFileIds": [
"sample string 1",
"sample string 2"
],
"LinkedLinkIds": [
"sample string 1",
"sample string 2"
],
"WorkPlanId": "e0700fab-5591-4253-aa54-f355bd4094b6",
"id": "14b8a83d-2cf5-4afd-b119-750fd07fc5eb",
"ConfigId": "f270cb24-6c11-474f-8af3-5e006b550ab6"
},
{
"WorkTypeId": "ec71ba84-4769-4d0a-8e44-a50c78eb6045",
"Name": "sample string 1",
"Created": "2026-06-05T16:18:07.5485312+00:00",
"Modified": "2026-06-05T16:18:07.5485312+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1125ff9b-a1a6-40ff-9780-51caff4c0e38",
"aec86b59-cf14-48d1-ba50-670b0ced2eb8"
],
"NonLaborAssignments": [
{
"Id": "d51953c4-9e38-4d52-88ae-b5eb191585f0",
"ResourceId": "85d5d7c5-b63a-44fa-9e0e-aec9926836c9",
"Quantity": 3.0
},
{
"Id": "d51953c4-9e38-4d52-88ae-b5eb191585f0",
"ResourceId": "85d5d7c5-b63a-44fa-9e0e-aec9926836c9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3796f4dd-e757-450d-a031-75ddd9e404fc",
"Type": 0,
"ResourceId": "6afd0a80-d4d2-49b3-b9c0-7561147533af",
"Units": 3.0
},
{
"Id": "3796f4dd-e757-450d-a031-75ddd9e404fc",
"Type": 0,
"ResourceId": "6afd0a80-d4d2-49b3-b9c0-7561147533af",
"Units": 3.0
}
],
"ParentId": "c7c38412-bc25-43d4-9a97-2c14969086c2",
"WorkTypeParentId": "de32d548-e6fd-4049-9033-05e8d8927a40",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c8524a7f-e82a-4bad-98e7-043aef45cba1",
"UPN": "920d3d15-ac79-4e7f-ac88-dcc7965c883f",
"PostDate": "2026-06-05T16:18:07.5485312+00:00",
"Comment": "sample string 4",
"CC": [
"410f2833-e5cd-4239-a723-3b81b7294671",
"c5d54cfb-d832-48f2-9883-653a48db09e7"
],
"Users": [
"3f211283-6940-431e-8a04-9d2cc87ca45a",
"99e1d5c4-cdc3-4041-adaf-fe9c6b2d82c3"
]
},
{
"Id": "c8524a7f-e82a-4bad-98e7-043aef45cba1",
"UPN": "920d3d15-ac79-4e7f-ac88-dcc7965c883f",
"PostDate": "2026-06-05T16:18:07.5485312+00:00",
"Comment": "sample string 4",
"CC": [
"410f2833-e5cd-4239-a723-3b81b7294671",
"c5d54cfb-d832-48f2-9883-653a48db09e7"
],
"Users": [
"3f211283-6940-431e-8a04-9d2cc87ca45a",
"99e1d5c4-cdc3-4041-adaf-fe9c6b2d82c3"
]
}
],
"StartDate": "2026-06-05T16:18:07.5485312+00:00",
"DueDate": "2026-06-05T16:18:07.5485312+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"a3a2873d-6d36-49a1-9477-825dfc17f66e": "47973a14-d993-4df8-8e63-10be1246883f",
"c716bd78-aeed-4a22-94ab-7414599e454e": "3df6a190-65d0-4196-ae0e-72f558630e33"
},
"HasUpdates": true,
"Modified": "2026-06-05T16:18:07.5485312+00:00",
"Editor": "sample string 3",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"CalcFields": {
"sample string 1": {},
"sample string 3": {}
},
"State": 0,
"ApproveRejectBy": "sample string 4",
"ApproveRejectDate": "2026-06-05T16:18:07.5485312+00:00"
},
"LastComment": "2026-06-05T16:18:07.5485312+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3e5b9df0-5db2-4f0a-b114-8a8e0415816f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"LinkedFileIds": [
"sample string 1",
"sample string 2"
],
"LinkedLinkIds": [
"sample string 1",
"sample string 2"
],
"WorkPlanId": "e0700fab-5591-4253-aa54-f355bd4094b6",
"id": "14b8a83d-2cf5-4afd-b119-750fd07fc5eb",
"ConfigId": "f270cb24-6c11-474f-8af3-5e006b550ab6"
}
]