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": "7d443bd4-9a4f-4911-91fa-7c0b5b41b233", "Name": "sample string 1", "Created": "2025-07-16T12:46:04.7553219+00:00", "Modified": "2025-07-16T12:46:04.7553219+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "0205bf8b-00f7-435a-903e-1899a03ee7dd", "427e5847-d5f1-44e2-b639-8054df46b9f1" ], "NonLaborAssignments": [ { "Id": "61e78deb-b897-46ec-8902-80add6f1e761", "ResourceId": "e9cf297e-d7ba-4d6e-954d-d302ffc1be23", "Quantity": 3.0 }, { "Id": "61e78deb-b897-46ec-8902-80add6f1e761", "ResourceId": "e9cf297e-d7ba-4d6e-954d-d302ffc1be23", "Quantity": 3.0 } ], "Assignments": [ { "Id": "d2c09be0-9ec3-41ff-b3ba-f9592354ac09", "Type": 0, "ResourceId": "e5ae4589-3575-4d65-b0a4-6fca9333b70b", "Units": 3.0 }, { "Id": "d2c09be0-9ec3-41ff-b3ba-f9592354ac09", "Type": 0, "ResourceId": "e5ae4589-3575-4d65-b0a4-6fca9333b70b", "Units": 3.0 } ], "ParentId": "18d911cc-a8e8-4e6c-a2e5-e8410697fdff", "WorkTypeParentId": "759624e0-b90b-4f05-bdd9-6c5fe8f8922c", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "d18b91f4-1585-4c65-a6f5-f57ff79b05bf", "UPN": "1c2f6c09-1026-40c6-ae8c-329f61a0f533", "PostDate": "2025-07-16T12:46:04.7553219+00:00", "Comment": "sample string 4", "CC": [ "f66cea04-eb8c-43d7-b6db-bb9a9cc992be", "8e0c19fd-bcd2-4eb0-a7e6-39d26bb49b8f" ], "Users": [ "2ec4a252-0a3f-4493-9a86-c7b7a1e2462e", "4ac44be9-18c9-44bd-87df-39a688cb5798" ] }, { "Id": "d18b91f4-1585-4c65-a6f5-f57ff79b05bf", "UPN": "1c2f6c09-1026-40c6-ae8c-329f61a0f533", "PostDate": "2025-07-16T12:46:04.7553219+00:00", "Comment": "sample string 4", "CC": [ "f66cea04-eb8c-43d7-b6db-bb9a9cc992be", "8e0c19fd-bcd2-4eb0-a7e6-39d26bb49b8f" ], "Users": [ "2ec4a252-0a3f-4493-9a86-c7b7a1e2462e", "4ac44be9-18c9-44bd-87df-39a688cb5798" ] } ], "StartDate": "2025-07-16T12:46:04.7553219+00:00", "DueDate": "2025-07-16T12:46:04.7553219+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "d0281f04-f3c0-46ff-a874-181155886dab": "c6649722-970d-47fd-b8ac-4c6bfe542268", "60e30bec-441b-488a-a792-2850f8b90448": "f3ded6b4-5523-4928-baee-8b7c14e998ed" }, "HasUpdates": true, "Modified": "2025-07-16T12:46:04.7553219+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-16T12:46:04.7553219+00:00" }, "LastComment": "2025-07-16T12:46:04.7553219+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "3c3fe433-94f1-4bde-8ddd-ebef25a90e67", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "d4041cac-ac91-4740-92f2-b4b095be83fe", "id": "69462c9f-b071-4f3d-a4d0-e1bf63c14eab", "ConfigId": "464291a1-1de0-4858-ab9c-0fda690706e5" }, { "WorkTypeId": "7d443bd4-9a4f-4911-91fa-7c0b5b41b233", "Name": "sample string 1", "Created": "2025-07-16T12:46:04.7553219+00:00", "Modified": "2025-07-16T12:46:04.7553219+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "0205bf8b-00f7-435a-903e-1899a03ee7dd", "427e5847-d5f1-44e2-b639-8054df46b9f1" ], "NonLaborAssignments": [ { "Id": "61e78deb-b897-46ec-8902-80add6f1e761", "ResourceId": "e9cf297e-d7ba-4d6e-954d-d302ffc1be23", "Quantity": 3.0 }, { "Id": "61e78deb-b897-46ec-8902-80add6f1e761", "ResourceId": "e9cf297e-d7ba-4d6e-954d-d302ffc1be23", "Quantity": 3.0 } ], "Assignments": [ { "Id": "d2c09be0-9ec3-41ff-b3ba-f9592354ac09", "Type": 0, "ResourceId": "e5ae4589-3575-4d65-b0a4-6fca9333b70b", "Units": 3.0 }, { "Id": "d2c09be0-9ec3-41ff-b3ba-f9592354ac09", "Type": 0, "ResourceId": "e5ae4589-3575-4d65-b0a4-6fca9333b70b", "Units": 3.0 } ], "ParentId": "18d911cc-a8e8-4e6c-a2e5-e8410697fdff", "WorkTypeParentId": "759624e0-b90b-4f05-bdd9-6c5fe8f8922c", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "d18b91f4-1585-4c65-a6f5-f57ff79b05bf", "UPN": "1c2f6c09-1026-40c6-ae8c-329f61a0f533", "PostDate": "2025-07-16T12:46:04.7553219+00:00", "Comment": "sample string 4", "CC": [ "f66cea04-eb8c-43d7-b6db-bb9a9cc992be", "8e0c19fd-bcd2-4eb0-a7e6-39d26bb49b8f" ], "Users": [ "2ec4a252-0a3f-4493-9a86-c7b7a1e2462e", "4ac44be9-18c9-44bd-87df-39a688cb5798" ] }, { "Id": "d18b91f4-1585-4c65-a6f5-f57ff79b05bf", "UPN": "1c2f6c09-1026-40c6-ae8c-329f61a0f533", "PostDate": "2025-07-16T12:46:04.7553219+00:00", "Comment": "sample string 4", "CC": [ "f66cea04-eb8c-43d7-b6db-bb9a9cc992be", "8e0c19fd-bcd2-4eb0-a7e6-39d26bb49b8f" ], "Users": [ "2ec4a252-0a3f-4493-9a86-c7b7a1e2462e", "4ac44be9-18c9-44bd-87df-39a688cb5798" ] } ], "StartDate": "2025-07-16T12:46:04.7553219+00:00", "DueDate": "2025-07-16T12:46:04.7553219+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "d0281f04-f3c0-46ff-a874-181155886dab": "c6649722-970d-47fd-b8ac-4c6bfe542268", "60e30bec-441b-488a-a792-2850f8b90448": "f3ded6b4-5523-4928-baee-8b7c14e998ed" }, "HasUpdates": true, "Modified": "2025-07-16T12:46:04.7553219+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-16T12:46:04.7553219+00:00" }, "LastComment": "2025-07-16T12:46:04.7553219+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "3c3fe433-94f1-4bde-8ddd-ebef25a90e67", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "d4041cac-ac91-4740-92f2-b4b095be83fe", "id": "69462c9f-b071-4f3d-a4d0-e1bf63c14eab", "ConfigId": "464291a1-1de0-4858-ab9c-0fda690706e5" } ]