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": "f5a7797c-d688-4e18-9bb2-7e12926deb9a",
"Name": "sample string 1",
"Created": "2026-07-21T13:03:26.3679384+00:00",
"Modified": "2026-07-21T13:03:26.3679384+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b9f863e5-ed4e-4d4f-a1f2-0cc1057b7639",
"dece2342-044f-4c83-88c4-acddeb345315"
],
"NonLaborAssignments": [
{
"Id": "f0f96ff6-6f99-4e83-88e9-ebeb50f95723",
"ResourceId": "364b7bff-7166-4645-a7af-ff17738d6234",
"Quantity": 3.0
},
{
"Id": "f0f96ff6-6f99-4e83-88e9-ebeb50f95723",
"ResourceId": "364b7bff-7166-4645-a7af-ff17738d6234",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "511b7771-2577-401f-93a4-f264a7f66fea",
"Type": 0,
"ResourceId": "ab7d931a-92f3-4b00-b564-32ebdaa368dd",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "511b7771-2577-401f-93a4-f264a7f66fea",
"Type": 0,
"ResourceId": "ab7d931a-92f3-4b00-b564-32ebdaa368dd",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "014f6615-e0c5-45b1-ae69-77d8d665cb20",
"WorkTypeParentId": "a3d8c0b8-1f75-4f06-ad25-76667fe0428d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f9c7f8cb-4c3b-493b-9bf5-6dbd1a723d45",
"UPN": "9fbd2f64-9585-4393-a0cd-9d4deaed6e11",
"PostDate": "2026-07-21T13:03:26.3679384+00:00",
"Comment": "sample string 4",
"CC": [
"c9ac745b-dc93-4559-887b-99c9580fe245",
"b862c06f-7ea1-4eea-960e-43205d80f794"
],
"Users": [
"49ccf1c3-0d43-4c82-812e-50eee36229e8",
"6bf44b18-540a-41e7-a709-5bf1880f0f21"
]
},
{
"Id": "f9c7f8cb-4c3b-493b-9bf5-6dbd1a723d45",
"UPN": "9fbd2f64-9585-4393-a0cd-9d4deaed6e11",
"PostDate": "2026-07-21T13:03:26.3679384+00:00",
"Comment": "sample string 4",
"CC": [
"c9ac745b-dc93-4559-887b-99c9580fe245",
"b862c06f-7ea1-4eea-960e-43205d80f794"
],
"Users": [
"49ccf1c3-0d43-4c82-812e-50eee36229e8",
"6bf44b18-540a-41e7-a709-5bf1880f0f21"
]
}
],
"StartDate": "2026-07-21T13:03:26.3679384+00:00",
"DueDate": "2026-07-21T13:03:26.3679384+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d7817535-cd85-4051-9a52-12e098a935ea": "7e4d4114-831d-4a44-971f-910f60e59819",
"56b75f1a-fdf4-46b7-b6ad-f0bc08fd89b1": "ed6ad5a0-68a6-488b-b3f2-5fe1610aa23d"
},
"HasUpdates": true,
"Modified": "2026-07-21T13:03:26.3679384+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-07-21T13:03:26.3679384+00:00"
},
"LastComment": "2026-07-21T13:03:26.3679384+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0da7e88d-86be-418b-8701-027cd46cf6d6",
"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": "39d0af93-0836-4273-8da3-754bfcf9f9fc",
"id": "e89cff15-7809-4633-9b8d-1c403af5c2ca",
"ConfigId": "552d0da4-98ea-429f-85d4-79946062ed14"
},
{
"WorkTypeId": "f5a7797c-d688-4e18-9bb2-7e12926deb9a",
"Name": "sample string 1",
"Created": "2026-07-21T13:03:26.3679384+00:00",
"Modified": "2026-07-21T13:03:26.3679384+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b9f863e5-ed4e-4d4f-a1f2-0cc1057b7639",
"dece2342-044f-4c83-88c4-acddeb345315"
],
"NonLaborAssignments": [
{
"Id": "f0f96ff6-6f99-4e83-88e9-ebeb50f95723",
"ResourceId": "364b7bff-7166-4645-a7af-ff17738d6234",
"Quantity": 3.0
},
{
"Id": "f0f96ff6-6f99-4e83-88e9-ebeb50f95723",
"ResourceId": "364b7bff-7166-4645-a7af-ff17738d6234",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "511b7771-2577-401f-93a4-f264a7f66fea",
"Type": 0,
"ResourceId": "ab7d931a-92f3-4b00-b564-32ebdaa368dd",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "511b7771-2577-401f-93a4-f264a7f66fea",
"Type": 0,
"ResourceId": "ab7d931a-92f3-4b00-b564-32ebdaa368dd",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "014f6615-e0c5-45b1-ae69-77d8d665cb20",
"WorkTypeParentId": "a3d8c0b8-1f75-4f06-ad25-76667fe0428d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f9c7f8cb-4c3b-493b-9bf5-6dbd1a723d45",
"UPN": "9fbd2f64-9585-4393-a0cd-9d4deaed6e11",
"PostDate": "2026-07-21T13:03:26.3679384+00:00",
"Comment": "sample string 4",
"CC": [
"c9ac745b-dc93-4559-887b-99c9580fe245",
"b862c06f-7ea1-4eea-960e-43205d80f794"
],
"Users": [
"49ccf1c3-0d43-4c82-812e-50eee36229e8",
"6bf44b18-540a-41e7-a709-5bf1880f0f21"
]
},
{
"Id": "f9c7f8cb-4c3b-493b-9bf5-6dbd1a723d45",
"UPN": "9fbd2f64-9585-4393-a0cd-9d4deaed6e11",
"PostDate": "2026-07-21T13:03:26.3679384+00:00",
"Comment": "sample string 4",
"CC": [
"c9ac745b-dc93-4559-887b-99c9580fe245",
"b862c06f-7ea1-4eea-960e-43205d80f794"
],
"Users": [
"49ccf1c3-0d43-4c82-812e-50eee36229e8",
"6bf44b18-540a-41e7-a709-5bf1880f0f21"
]
}
],
"StartDate": "2026-07-21T13:03:26.3679384+00:00",
"DueDate": "2026-07-21T13:03:26.3679384+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d7817535-cd85-4051-9a52-12e098a935ea": "7e4d4114-831d-4a44-971f-910f60e59819",
"56b75f1a-fdf4-46b7-b6ad-f0bc08fd89b1": "ed6ad5a0-68a6-488b-b3f2-5fe1610aa23d"
},
"HasUpdates": true,
"Modified": "2026-07-21T13:03:26.3679384+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-07-21T13:03:26.3679384+00:00"
},
"LastComment": "2026-07-21T13:03:26.3679384+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0da7e88d-86be-418b-8701-027cd46cf6d6",
"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": "39d0af93-0836-4273-8da3-754bfcf9f9fc",
"id": "e89cff15-7809-4633-9b8d-1c403af5c2ca",
"ConfigId": "552d0da4-98ea-429f-85d4-79946062ed14"
}
]