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": "b738bb81-0e16-4fb1-b2fd-36ff4da91fa7", "Name": "sample string 1", "Created": "2025-07-08T19:46:47.4934978+00:00", "Modified": "2025-07-08T19:46:47.4934978+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "b3814fd1-60e7-46f7-aaf1-a2079eccb67e", "abf98ad1-392a-4468-992c-4e9e0d7826fc" ], "NonLaborAssignments": [ { "Id": "120819e3-39c8-41c2-9705-277e177082dd", "ResourceId": "a4216503-e350-4c2e-aef8-5cc187542971", "Quantity": 3.0 }, { "Id": "120819e3-39c8-41c2-9705-277e177082dd", "ResourceId": "a4216503-e350-4c2e-aef8-5cc187542971", "Quantity": 3.0 } ], "Assignments": [ { "Id": "656a361b-bfc4-4d1f-a485-794142a8466c", "Type": 0, "ResourceId": "e091a887-85a2-4003-b8de-c13aae45f072", "Units": 3.0 }, { "Id": "656a361b-bfc4-4d1f-a485-794142a8466c", "Type": 0, "ResourceId": "e091a887-85a2-4003-b8de-c13aae45f072", "Units": 3.0 } ], "ParentId": "de08e016-e102-49c7-9d5b-0a696d2b5cab", "WorkTypeParentId": "3866d8a7-ea2d-41ee-8d46-168ffd62e463", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "c54b4f6a-3969-4cbc-8557-a7da98b7d5e3", "UPN": "87a5b297-d692-4b94-8b6b-9bf1df413703", "PostDate": "2025-07-08T19:46:47.4934978+00:00", "Comment": "sample string 4", "CC": [ "d8298737-0097-4255-98b5-a3d2b4b01f78", "a0e8b0e1-5ab7-49e3-910c-3041478f8753" ], "Users": [ "148f7ad6-d560-4ad4-a4f1-9360c998faf0", "d930b342-8769-4f36-ad56-efea13e1d69f" ] }, { "Id": "c54b4f6a-3969-4cbc-8557-a7da98b7d5e3", "UPN": "87a5b297-d692-4b94-8b6b-9bf1df413703", "PostDate": "2025-07-08T19:46:47.4934978+00:00", "Comment": "sample string 4", "CC": [ "d8298737-0097-4255-98b5-a3d2b4b01f78", "a0e8b0e1-5ab7-49e3-910c-3041478f8753" ], "Users": [ "148f7ad6-d560-4ad4-a4f1-9360c998faf0", "d930b342-8769-4f36-ad56-efea13e1d69f" ] } ], "StartDate": "2025-07-08T19:46:47.4934978+00:00", "DueDate": "2025-07-08T19:46:47.4934978+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "54013eab-85e1-4342-993c-0b4db9d3ccfc": "f98eafe3-a664-470a-a56d-8f60e4e8e24f", "8dd5979e-213c-4d29-8b5b-15e4c2325575": "791622e2-28d2-402b-bca9-2676aa4e25ba" }, "HasUpdates": true, "Modified": "2025-07-08T19:46:47.4934978+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-07-08T19:46:47.4934978+00:00" }, "LastComment": "2025-07-08T19:46:47.4934978+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "799ec7ff-5344-441c-bb2b-19d8b331b4f8", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "3520b204-a37d-4c36-83b3-1cde2d14c74a", "id": "e83133f8-8408-4ff2-95c7-ebbc897e29f4", "ConfigId": "a252cc7c-3c12-459d-ba65-b02e629b8290" }, { "WorkTypeId": "b738bb81-0e16-4fb1-b2fd-36ff4da91fa7", "Name": "sample string 1", "Created": "2025-07-08T19:46:47.4934978+00:00", "Modified": "2025-07-08T19:46:47.4934978+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "b3814fd1-60e7-46f7-aaf1-a2079eccb67e", "abf98ad1-392a-4468-992c-4e9e0d7826fc" ], "NonLaborAssignments": [ { "Id": "120819e3-39c8-41c2-9705-277e177082dd", "ResourceId": "a4216503-e350-4c2e-aef8-5cc187542971", "Quantity": 3.0 }, { "Id": "120819e3-39c8-41c2-9705-277e177082dd", "ResourceId": "a4216503-e350-4c2e-aef8-5cc187542971", "Quantity": 3.0 } ], "Assignments": [ { "Id": "656a361b-bfc4-4d1f-a485-794142a8466c", "Type": 0, "ResourceId": "e091a887-85a2-4003-b8de-c13aae45f072", "Units": 3.0 }, { "Id": "656a361b-bfc4-4d1f-a485-794142a8466c", "Type": 0, "ResourceId": "e091a887-85a2-4003-b8de-c13aae45f072", "Units": 3.0 } ], "ParentId": "de08e016-e102-49c7-9d5b-0a696d2b5cab", "WorkTypeParentId": "3866d8a7-ea2d-41ee-8d46-168ffd62e463", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "c54b4f6a-3969-4cbc-8557-a7da98b7d5e3", "UPN": "87a5b297-d692-4b94-8b6b-9bf1df413703", "PostDate": "2025-07-08T19:46:47.4934978+00:00", "Comment": "sample string 4", "CC": [ "d8298737-0097-4255-98b5-a3d2b4b01f78", "a0e8b0e1-5ab7-49e3-910c-3041478f8753" ], "Users": [ "148f7ad6-d560-4ad4-a4f1-9360c998faf0", "d930b342-8769-4f36-ad56-efea13e1d69f" ] }, { "Id": "c54b4f6a-3969-4cbc-8557-a7da98b7d5e3", "UPN": "87a5b297-d692-4b94-8b6b-9bf1df413703", "PostDate": "2025-07-08T19:46:47.4934978+00:00", "Comment": "sample string 4", "CC": [ "d8298737-0097-4255-98b5-a3d2b4b01f78", "a0e8b0e1-5ab7-49e3-910c-3041478f8753" ], "Users": [ "148f7ad6-d560-4ad4-a4f1-9360c998faf0", "d930b342-8769-4f36-ad56-efea13e1d69f" ] } ], "StartDate": "2025-07-08T19:46:47.4934978+00:00", "DueDate": "2025-07-08T19:46:47.4934978+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "54013eab-85e1-4342-993c-0b4db9d3ccfc": "f98eafe3-a664-470a-a56d-8f60e4e8e24f", "8dd5979e-213c-4d29-8b5b-15e4c2325575": "791622e2-28d2-402b-bca9-2676aa4e25ba" }, "HasUpdates": true, "Modified": "2025-07-08T19:46:47.4934978+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-07-08T19:46:47.4934978+00:00" }, "LastComment": "2025-07-08T19:46:47.4934978+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "799ec7ff-5344-441c-bb2b-19d8b331b4f8", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "3520b204-a37d-4c36-83b3-1cde2d14c74a", "id": "e83133f8-8408-4ff2-95c7-ebbc897e29f4", "ConfigId": "a252cc7c-3c12-459d-ba65-b02e629b8290" } ]