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": "dc4495ab-99ac-4f18-90ec-0d0be7c9e0ce",
"Name": "sample string 1",
"Created": "2026-05-02T16:43:13.9035292+00:00",
"Modified": "2026-05-02T16:43:13.9035292+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"6faf4190-8f95-44ef-ae24-aba5cef337ce",
"c7f52802-0037-4aaa-9541-370401a1cae3"
],
"NonLaborAssignments": [
{
"Id": "0f712c0e-2227-480c-ad62-e6f125937a5f",
"ResourceId": "59e8993a-400f-413c-a64e-0cde834573f3",
"Quantity": 3.0
},
{
"Id": "0f712c0e-2227-480c-ad62-e6f125937a5f",
"ResourceId": "59e8993a-400f-413c-a64e-0cde834573f3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "9a9ab6a9-5e80-41e5-965e-6f65f409b4d9",
"Type": 0,
"ResourceId": "e46e3edf-f1bc-4df8-b144-951bd7814ccc",
"Units": 3.0
},
{
"Id": "9a9ab6a9-5e80-41e5-965e-6f65f409b4d9",
"Type": 0,
"ResourceId": "e46e3edf-f1bc-4df8-b144-951bd7814ccc",
"Units": 3.0
}
],
"ParentId": "24d339c9-6f5c-43c3-b7c4-139d8d0a9fe6",
"WorkTypeParentId": "d0086a92-ddf3-49f2-a7a9-1a34f8841bcc",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f1c7de4c-1d9d-4195-8e25-cb052f427f6a",
"UPN": "55848bec-e9ff-461f-ac65-d68a6e9b380d",
"PostDate": "2026-05-02T16:43:13.9035292+00:00",
"Comment": "sample string 4",
"CC": [
"8be9ed2d-7eb5-45e5-a1e3-0ad222f33331",
"9615484e-eb98-454d-a957-f90694e6ea4f"
],
"Users": [
"ba8ebf64-c63b-4957-bc00-ece3af8eb56d",
"ea47eee1-a0c1-43d0-92b7-035717036a38"
]
},
{
"Id": "f1c7de4c-1d9d-4195-8e25-cb052f427f6a",
"UPN": "55848bec-e9ff-461f-ac65-d68a6e9b380d",
"PostDate": "2026-05-02T16:43:13.9035292+00:00",
"Comment": "sample string 4",
"CC": [
"8be9ed2d-7eb5-45e5-a1e3-0ad222f33331",
"9615484e-eb98-454d-a957-f90694e6ea4f"
],
"Users": [
"ba8ebf64-c63b-4957-bc00-ece3af8eb56d",
"ea47eee1-a0c1-43d0-92b7-035717036a38"
]
}
],
"StartDate": "2026-05-02T16:43:13.9035292+00:00",
"DueDate": "2026-05-02T16:43:13.9035292+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3c314f8a-d308-4e5b-a1e7-3e3d28f509a8": "c114725b-743c-464d-a034-4a09334c68a5",
"8ab9a7dc-cfe0-4dff-be23-98b0eb5c7067": "a68d693b-22fd-4a33-ba7e-6522d48d36d6"
},
"HasUpdates": true,
"Modified": "2026-05-02T16:43:13.9035292+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-05-02T16:43:13.9035292+00:00"
},
"LastComment": "2026-05-02T16:43:13.9035292+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ba8dadf6-3fc8-48e8-ab94-af3beecd426c",
"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": "c8d0f66f-929c-4f05-b1a1-230985b27293",
"id": "fc7c4f8b-1d9e-41c9-bfc2-57ca954068da",
"ConfigId": "03b28cb5-b768-43e7-8c28-0033fa1b15f7"
},
{
"WorkTypeId": "dc4495ab-99ac-4f18-90ec-0d0be7c9e0ce",
"Name": "sample string 1",
"Created": "2026-05-02T16:43:13.9035292+00:00",
"Modified": "2026-05-02T16:43:13.9035292+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"6faf4190-8f95-44ef-ae24-aba5cef337ce",
"c7f52802-0037-4aaa-9541-370401a1cae3"
],
"NonLaborAssignments": [
{
"Id": "0f712c0e-2227-480c-ad62-e6f125937a5f",
"ResourceId": "59e8993a-400f-413c-a64e-0cde834573f3",
"Quantity": 3.0
},
{
"Id": "0f712c0e-2227-480c-ad62-e6f125937a5f",
"ResourceId": "59e8993a-400f-413c-a64e-0cde834573f3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "9a9ab6a9-5e80-41e5-965e-6f65f409b4d9",
"Type": 0,
"ResourceId": "e46e3edf-f1bc-4df8-b144-951bd7814ccc",
"Units": 3.0
},
{
"Id": "9a9ab6a9-5e80-41e5-965e-6f65f409b4d9",
"Type": 0,
"ResourceId": "e46e3edf-f1bc-4df8-b144-951bd7814ccc",
"Units": 3.0
}
],
"ParentId": "24d339c9-6f5c-43c3-b7c4-139d8d0a9fe6",
"WorkTypeParentId": "d0086a92-ddf3-49f2-a7a9-1a34f8841bcc",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f1c7de4c-1d9d-4195-8e25-cb052f427f6a",
"UPN": "55848bec-e9ff-461f-ac65-d68a6e9b380d",
"PostDate": "2026-05-02T16:43:13.9035292+00:00",
"Comment": "sample string 4",
"CC": [
"8be9ed2d-7eb5-45e5-a1e3-0ad222f33331",
"9615484e-eb98-454d-a957-f90694e6ea4f"
],
"Users": [
"ba8ebf64-c63b-4957-bc00-ece3af8eb56d",
"ea47eee1-a0c1-43d0-92b7-035717036a38"
]
},
{
"Id": "f1c7de4c-1d9d-4195-8e25-cb052f427f6a",
"UPN": "55848bec-e9ff-461f-ac65-d68a6e9b380d",
"PostDate": "2026-05-02T16:43:13.9035292+00:00",
"Comment": "sample string 4",
"CC": [
"8be9ed2d-7eb5-45e5-a1e3-0ad222f33331",
"9615484e-eb98-454d-a957-f90694e6ea4f"
],
"Users": [
"ba8ebf64-c63b-4957-bc00-ece3af8eb56d",
"ea47eee1-a0c1-43d0-92b7-035717036a38"
]
}
],
"StartDate": "2026-05-02T16:43:13.9035292+00:00",
"DueDate": "2026-05-02T16:43:13.9035292+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3c314f8a-d308-4e5b-a1e7-3e3d28f509a8": "c114725b-743c-464d-a034-4a09334c68a5",
"8ab9a7dc-cfe0-4dff-be23-98b0eb5c7067": "a68d693b-22fd-4a33-ba7e-6522d48d36d6"
},
"HasUpdates": true,
"Modified": "2026-05-02T16:43:13.9035292+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-05-02T16:43:13.9035292+00:00"
},
"LastComment": "2026-05-02T16:43:13.9035292+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ba8dadf6-3fc8-48e8-ab94-af3beecd426c",
"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": "c8d0f66f-929c-4f05-b1a1-230985b27293",
"id": "fc7c4f8b-1d9e-41c9-bfc2-57ca954068da",
"ConfigId": "03b28cb5-b768-43e7-8c28-0033fa1b15f7"
}
]