GET api/workplan/{id}/tasks?HasUpdates={HasUpdates}&FilterField={FilterField}&FilterValue={FilterValue}
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 |
Body Parameters
None.
Response Information
Resource Description
Collection of WorkPlanTaskName | 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. |
|
WorkPlanId | globally unique identifier |
None. |
|
id | globally unique identifier |
None. |
|
ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "WorkTypeId": "f4b6b3c7-605b-4b96-87e2-0e60eaa14ed4", "Name": "sample string 1", "Created": "2025-10-18T22:12:23.5129851+00:00", "Modified": "2025-10-18T22:12:23.5129851+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "cb6ff817-7454-42a7-a396-5acd23191115", "97145f28-5889-4841-a206-4edd16bbfec9" ], "NonLaborAssignments": [ { "Id": "d3386643-c634-40eb-b2b8-775eab42fc2c", "ResourceId": "a8a0286e-cdfb-4f75-b290-e70012f575b5", "Quantity": 3.0 }, { "Id": "d3386643-c634-40eb-b2b8-775eab42fc2c", "ResourceId": "a8a0286e-cdfb-4f75-b290-e70012f575b5", "Quantity": 3.0 } ], "Assignments": [ { "Id": "5e576e92-d28d-4534-98ee-1fdc7b5c6f62", "Type": 0, "ResourceId": "a0a039e0-8ed9-4f33-9476-287062b20eb4", "Units": 3.0 }, { "Id": "5e576e92-d28d-4534-98ee-1fdc7b5c6f62", "Type": 0, "ResourceId": "a0a039e0-8ed9-4f33-9476-287062b20eb4", "Units": 3.0 } ], "ParentId": "2573365b-20a7-482b-a9b8-f0dceb38121a", "WorkTypeParentId": "f25d4ce3-5269-4b68-af62-41db1a448aee", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "5404d0a7-80f7-43fc-9254-396099f2ff26", "UPN": "f1cca7b0-78e9-4c57-b433-154b2340a7fd", "PostDate": "2025-10-18T22:12:23.5129851+00:00", "Comment": "sample string 4", "CC": [ "8dae4a37-26da-4364-bbf0-7a3b9ca00334", "17ef8e96-70f4-4d81-b628-39f3366b6abe" ], "Users": [ "698c5513-15f8-4e22-9db8-03749494a231", "455d39f7-1d06-455c-bbb1-89823d16c038" ] }, { "Id": "5404d0a7-80f7-43fc-9254-396099f2ff26", "UPN": "f1cca7b0-78e9-4c57-b433-154b2340a7fd", "PostDate": "2025-10-18T22:12:23.5129851+00:00", "Comment": "sample string 4", "CC": [ "8dae4a37-26da-4364-bbf0-7a3b9ca00334", "17ef8e96-70f4-4d81-b628-39f3366b6abe" ], "Users": [ "698c5513-15f8-4e22-9db8-03749494a231", "455d39f7-1d06-455c-bbb1-89823d16c038" ] } ], "StartDate": "2025-10-18T22:12:23.5129851+00:00", "DueDate": "2025-10-18T22:12:23.5129851+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "4bc88198-f0fa-4a6b-914e-c6b5b9c3fbdf": "11e33578-dced-4d7b-87b3-0a08068544ce", "6382f1eb-d48c-4bbd-86be-0249993499f4": "d17f8df3-bf09-4f26-856c-61be5b411ee2" }, "HasUpdates": true, "Modified": "2025-10-18T22:12:23.5286082+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": "2025-10-18T22:12:23.5286082+00:00" }, "LastComment": "2025-10-18T22:12:23.5286082+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "4e4e3a12-f8ce-40df-8431-72b78c4880f9", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "9830cefe-6882-4d50-9702-cd5961d41ef6", "id": "4f2c1f47-7dd6-4001-83c4-072949e71dde", "ConfigId": "605cbab6-06b7-42e3-a92f-76d7f3bf4ee3" }, { "WorkTypeId": "f4b6b3c7-605b-4b96-87e2-0e60eaa14ed4", "Name": "sample string 1", "Created": "2025-10-18T22:12:23.5129851+00:00", "Modified": "2025-10-18T22:12:23.5129851+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "cb6ff817-7454-42a7-a396-5acd23191115", "97145f28-5889-4841-a206-4edd16bbfec9" ], "NonLaborAssignments": [ { "Id": "d3386643-c634-40eb-b2b8-775eab42fc2c", "ResourceId": "a8a0286e-cdfb-4f75-b290-e70012f575b5", "Quantity": 3.0 }, { "Id": "d3386643-c634-40eb-b2b8-775eab42fc2c", "ResourceId": "a8a0286e-cdfb-4f75-b290-e70012f575b5", "Quantity": 3.0 } ], "Assignments": [ { "Id": "5e576e92-d28d-4534-98ee-1fdc7b5c6f62", "Type": 0, "ResourceId": "a0a039e0-8ed9-4f33-9476-287062b20eb4", "Units": 3.0 }, { "Id": "5e576e92-d28d-4534-98ee-1fdc7b5c6f62", "Type": 0, "ResourceId": "a0a039e0-8ed9-4f33-9476-287062b20eb4", "Units": 3.0 } ], "ParentId": "2573365b-20a7-482b-a9b8-f0dceb38121a", "WorkTypeParentId": "f25d4ce3-5269-4b68-af62-41db1a448aee", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "5404d0a7-80f7-43fc-9254-396099f2ff26", "UPN": "f1cca7b0-78e9-4c57-b433-154b2340a7fd", "PostDate": "2025-10-18T22:12:23.5129851+00:00", "Comment": "sample string 4", "CC": [ "8dae4a37-26da-4364-bbf0-7a3b9ca00334", "17ef8e96-70f4-4d81-b628-39f3366b6abe" ], "Users": [ "698c5513-15f8-4e22-9db8-03749494a231", "455d39f7-1d06-455c-bbb1-89823d16c038" ] }, { "Id": "5404d0a7-80f7-43fc-9254-396099f2ff26", "UPN": "f1cca7b0-78e9-4c57-b433-154b2340a7fd", "PostDate": "2025-10-18T22:12:23.5129851+00:00", "Comment": "sample string 4", "CC": [ "8dae4a37-26da-4364-bbf0-7a3b9ca00334", "17ef8e96-70f4-4d81-b628-39f3366b6abe" ], "Users": [ "698c5513-15f8-4e22-9db8-03749494a231", "455d39f7-1d06-455c-bbb1-89823d16c038" ] } ], "StartDate": "2025-10-18T22:12:23.5129851+00:00", "DueDate": "2025-10-18T22:12:23.5129851+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "4bc88198-f0fa-4a6b-914e-c6b5b9c3fbdf": "11e33578-dced-4d7b-87b3-0a08068544ce", "6382f1eb-d48c-4bbd-86be-0249993499f4": "d17f8df3-bf09-4f26-856c-61be5b411ee2" }, "HasUpdates": true, "Modified": "2025-10-18T22:12:23.5286082+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": "2025-10-18T22:12:23.5286082+00:00" }, "LastComment": "2025-10-18T22:12:23.5286082+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "4e4e3a12-f8ce-40df-8431-72b78c4880f9", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "9830cefe-6882-4d50-9702-cd5961d41ef6", "id": "4f2c1f47-7dd6-4001-83c4-072949e71dde", "ConfigId": "605cbab6-06b7-42e3-a92f-76d7f3bf4ee3" } ]