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": "f67ddc04-e7e4-422b-8f3e-2d95a085b41a",
"Name": "sample string 1",
"Created": "2026-09-29T19:18:20.208871+00:00",
"Modified": "2026-09-29T19:18:20.208871+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1205e785-43c5-4000-8e2a-e6e239d3f143",
"f90fdfb5-44c5-4851-8ff8-c78d1dc9dfe6"
],
"NonLaborAssignments": [
{
"Id": "614e996c-8101-4224-b528-8941116cacea",
"ResourceId": "fe39b5f2-42e1-4c46-914e-3190be79538d",
"Quantity": 3.0
},
{
"Id": "614e996c-8101-4224-b528-8941116cacea",
"ResourceId": "fe39b5f2-42e1-4c46-914e-3190be79538d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "71074d2f-8d59-44d9-9939-a9b177fbf348",
"Type": 0,
"ResourceId": "9b835383-ea1c-4d21-a6db-42666d3566a7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "44e9b7e5-fd8c-49fb-9522-45cc04c16dd8",
"Start": "2026-09-29T19:18:20.208871+00:00",
"Due": "2026-09-29T19:18:20.208871+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "44e9b7e5-fd8c-49fb-9522-45cc04c16dd8",
"Start": "2026-09-29T19:18:20.208871+00:00",
"Due": "2026-09-29T19:18:20.208871+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "71074d2f-8d59-44d9-9939-a9b177fbf348",
"Type": 0,
"ResourceId": "9b835383-ea1c-4d21-a6db-42666d3566a7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "44e9b7e5-fd8c-49fb-9522-45cc04c16dd8",
"Start": "2026-09-29T19:18:20.208871+00:00",
"Due": "2026-09-29T19:18:20.208871+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "44e9b7e5-fd8c-49fb-9522-45cc04c16dd8",
"Start": "2026-09-29T19:18:20.208871+00:00",
"Due": "2026-09-29T19:18:20.208871+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "daf617af-7ab7-4d2e-8b2f-1facc61a4cf4",
"WorkTypeParentId": "611f00e3-e73d-437f-b448-356accf0b39a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "584223d2-1278-4f6d-8d5a-95e956ecad50",
"UPN": "89ebb872-967d-4ee0-bd7b-e380a8402faf",
"PostDate": "2026-09-29T19:18:20.208871+00:00",
"Comment": "sample string 4",
"CC": [
"03d31c28-33cf-44d4-8ba5-6051ca903544",
"f5cd4f48-5b2b-4b56-abc4-784f981ce67c"
],
"Users": [
"43a06c7c-51ea-4f92-9f1a-921a15e0db3a",
"54a737c3-2d69-4018-a462-7d43179c097a"
]
},
{
"Id": "584223d2-1278-4f6d-8d5a-95e956ecad50",
"UPN": "89ebb872-967d-4ee0-bd7b-e380a8402faf",
"PostDate": "2026-09-29T19:18:20.208871+00:00",
"Comment": "sample string 4",
"CC": [
"03d31c28-33cf-44d4-8ba5-6051ca903544",
"f5cd4f48-5b2b-4b56-abc4-784f981ce67c"
],
"Users": [
"43a06c7c-51ea-4f92-9f1a-921a15e0db3a",
"54a737c3-2d69-4018-a462-7d43179c097a"
]
}
],
"StartDate": "2026-09-29T19:18:20.208871+00:00",
"DueDate": "2026-09-29T19:18:20.208871+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ef3c466a-c954-40bc-b494-cb2dce102e71": "5b945ff7-5706-49c2-90a4-cd7659f78f73",
"d9b089a7-2691-4d1c-b42c-7000af1db421": "79be150e-97c8-4edd-8183-9fbc61aa0d27"
},
"HasUpdates": true,
"Modified": "2026-09-29T19:18:20.208871+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-09-29T19:18:20.208871+00:00"
},
"LastComment": "2026-09-29T19:18:20.208871+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f4b69b69-8b55-4d02-9fbd-ddb0c84c98bb",
"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": "23d482a4-1d2c-4bdd-88aa-06fed9159ad1",
"id": "99ae0d88-cc9a-4036-9f3f-f48279494bf4",
"ConfigId": "6db76f7f-6ccf-4017-bce2-757550845af9"
},
{
"WorkTypeId": "f67ddc04-e7e4-422b-8f3e-2d95a085b41a",
"Name": "sample string 1",
"Created": "2026-09-29T19:18:20.208871+00:00",
"Modified": "2026-09-29T19:18:20.208871+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1205e785-43c5-4000-8e2a-e6e239d3f143",
"f90fdfb5-44c5-4851-8ff8-c78d1dc9dfe6"
],
"NonLaborAssignments": [
{
"Id": "614e996c-8101-4224-b528-8941116cacea",
"ResourceId": "fe39b5f2-42e1-4c46-914e-3190be79538d",
"Quantity": 3.0
},
{
"Id": "614e996c-8101-4224-b528-8941116cacea",
"ResourceId": "fe39b5f2-42e1-4c46-914e-3190be79538d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "71074d2f-8d59-44d9-9939-a9b177fbf348",
"Type": 0,
"ResourceId": "9b835383-ea1c-4d21-a6db-42666d3566a7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "44e9b7e5-fd8c-49fb-9522-45cc04c16dd8",
"Start": "2026-09-29T19:18:20.208871+00:00",
"Due": "2026-09-29T19:18:20.208871+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "44e9b7e5-fd8c-49fb-9522-45cc04c16dd8",
"Start": "2026-09-29T19:18:20.208871+00:00",
"Due": "2026-09-29T19:18:20.208871+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "71074d2f-8d59-44d9-9939-a9b177fbf348",
"Type": 0,
"ResourceId": "9b835383-ea1c-4d21-a6db-42666d3566a7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "44e9b7e5-fd8c-49fb-9522-45cc04c16dd8",
"Start": "2026-09-29T19:18:20.208871+00:00",
"Due": "2026-09-29T19:18:20.208871+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "44e9b7e5-fd8c-49fb-9522-45cc04c16dd8",
"Start": "2026-09-29T19:18:20.208871+00:00",
"Due": "2026-09-29T19:18:20.208871+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "daf617af-7ab7-4d2e-8b2f-1facc61a4cf4",
"WorkTypeParentId": "611f00e3-e73d-437f-b448-356accf0b39a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "584223d2-1278-4f6d-8d5a-95e956ecad50",
"UPN": "89ebb872-967d-4ee0-bd7b-e380a8402faf",
"PostDate": "2026-09-29T19:18:20.208871+00:00",
"Comment": "sample string 4",
"CC": [
"03d31c28-33cf-44d4-8ba5-6051ca903544",
"f5cd4f48-5b2b-4b56-abc4-784f981ce67c"
],
"Users": [
"43a06c7c-51ea-4f92-9f1a-921a15e0db3a",
"54a737c3-2d69-4018-a462-7d43179c097a"
]
},
{
"Id": "584223d2-1278-4f6d-8d5a-95e956ecad50",
"UPN": "89ebb872-967d-4ee0-bd7b-e380a8402faf",
"PostDate": "2026-09-29T19:18:20.208871+00:00",
"Comment": "sample string 4",
"CC": [
"03d31c28-33cf-44d4-8ba5-6051ca903544",
"f5cd4f48-5b2b-4b56-abc4-784f981ce67c"
],
"Users": [
"43a06c7c-51ea-4f92-9f1a-921a15e0db3a",
"54a737c3-2d69-4018-a462-7d43179c097a"
]
}
],
"StartDate": "2026-09-29T19:18:20.208871+00:00",
"DueDate": "2026-09-29T19:18:20.208871+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ef3c466a-c954-40bc-b494-cb2dce102e71": "5b945ff7-5706-49c2-90a4-cd7659f78f73",
"d9b089a7-2691-4d1c-b42c-7000af1db421": "79be150e-97c8-4edd-8183-9fbc61aa0d27"
},
"HasUpdates": true,
"Modified": "2026-09-29T19:18:20.208871+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-09-29T19:18:20.208871+00:00"
},
"LastComment": "2026-09-29T19:18:20.208871+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f4b69b69-8b55-4d02-9fbd-ddb0c84c98bb",
"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": "23d482a4-1d2c-4bdd-88aa-06fed9159ad1",
"id": "99ae0d88-cc9a-4036-9f3f-f48279494bf4",
"ConfigId": "6db76f7f-6ccf-4017-bce2-757550845af9"
}
]