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. |
|
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": "e4767544-2014-4cc9-90b6-2412e6719ae8", "Name": "sample string 1", "Created": "2025-05-23T21:50:55.5959647+00:00", "Modified": "2025-05-23T21:50:55.5959647+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "6108a1d3-7d6d-4b39-a3de-3aea8a1f63d0", "2520a027-1391-4cb9-b9c9-318361eda73b" ], "Assignments": [ { "Id": "e1ad3d8c-7905-4609-9d96-c88d1fbd8560", "Type": 0, "ResourceId": "bc33124d-455e-493d-9d1a-23c84a1e6eb4", "Units": 3.0 }, { "Id": "e1ad3d8c-7905-4609-9d96-c88d1fbd8560", "Type": 0, "ResourceId": "bc33124d-455e-493d-9d1a-23c84a1e6eb4", "Units": 3.0 } ], "ParentId": "9dd1df4b-4698-446f-aad2-a154f251ced7", "WorkTypeParentId": "9c15c7d8-9018-41fb-87c1-3b334f0bbcd1", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "014ba9a1-5a12-4af9-91ef-e3067c94b5d1", "UPN": "185701d0-5fb3-4b56-bf0d-8aeb19bbe497", "PostDate": "2025-05-23T21:50:55.5959647+00:00", "Comment": "sample string 4", "CC": [ "f6f7b06f-a854-48bf-8039-5ee8d5a992ae", "1487e501-e65f-4408-83d3-e7e0048f2c30" ], "Users": [ "e288c458-7c68-474e-90ff-e466b276e53b", "02dae8af-29ff-4520-9fd4-da1a3b2edeb3" ] }, { "Id": "014ba9a1-5a12-4af9-91ef-e3067c94b5d1", "UPN": "185701d0-5fb3-4b56-bf0d-8aeb19bbe497", "PostDate": "2025-05-23T21:50:55.5959647+00:00", "Comment": "sample string 4", "CC": [ "f6f7b06f-a854-48bf-8039-5ee8d5a992ae", "1487e501-e65f-4408-83d3-e7e0048f2c30" ], "Users": [ "e288c458-7c68-474e-90ff-e466b276e53b", "02dae8af-29ff-4520-9fd4-da1a3b2edeb3" ] } ], "StartDate": "2025-05-23T21:50:55.5959647+00:00", "DueDate": "2025-05-23T21:50:55.5959647+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "3a545960-e2f3-46f3-98db-b1ef7dc50f71": "97803ffb-ff8f-46ae-95e1-9ded8be7ace4", "3fb268a6-18bc-43fb-af77-ed749fd0dca1": "91597a0c-1d8c-4931-8042-9c0bb8af315b" }, "HasUpdates": true, "Modified": "2025-05-23T21:50:55.5959647+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-05-23T21:50:55.5959647+00:00" }, "LastComment": "2025-05-23T21:50:55.5959647+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "c9b3c4e8-cda4-4962-9687-52567ede6002", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "e749946d-ff62-47ad-8469-e0d2c12979f0", "id": "0587f653-08a1-4dda-aa9b-e82e0e591c5c", "ConfigId": "5eb6b78c-ae1a-456c-a7f7-95239e207e68" }, { "WorkTypeId": "e4767544-2014-4cc9-90b6-2412e6719ae8", "Name": "sample string 1", "Created": "2025-05-23T21:50:55.5959647+00:00", "Modified": "2025-05-23T21:50:55.5959647+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "6108a1d3-7d6d-4b39-a3de-3aea8a1f63d0", "2520a027-1391-4cb9-b9c9-318361eda73b" ], "Assignments": [ { "Id": "e1ad3d8c-7905-4609-9d96-c88d1fbd8560", "Type": 0, "ResourceId": "bc33124d-455e-493d-9d1a-23c84a1e6eb4", "Units": 3.0 }, { "Id": "e1ad3d8c-7905-4609-9d96-c88d1fbd8560", "Type": 0, "ResourceId": "bc33124d-455e-493d-9d1a-23c84a1e6eb4", "Units": 3.0 } ], "ParentId": "9dd1df4b-4698-446f-aad2-a154f251ced7", "WorkTypeParentId": "9c15c7d8-9018-41fb-87c1-3b334f0bbcd1", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "014ba9a1-5a12-4af9-91ef-e3067c94b5d1", "UPN": "185701d0-5fb3-4b56-bf0d-8aeb19bbe497", "PostDate": "2025-05-23T21:50:55.5959647+00:00", "Comment": "sample string 4", "CC": [ "f6f7b06f-a854-48bf-8039-5ee8d5a992ae", "1487e501-e65f-4408-83d3-e7e0048f2c30" ], "Users": [ "e288c458-7c68-474e-90ff-e466b276e53b", "02dae8af-29ff-4520-9fd4-da1a3b2edeb3" ] }, { "Id": "014ba9a1-5a12-4af9-91ef-e3067c94b5d1", "UPN": "185701d0-5fb3-4b56-bf0d-8aeb19bbe497", "PostDate": "2025-05-23T21:50:55.5959647+00:00", "Comment": "sample string 4", "CC": [ "f6f7b06f-a854-48bf-8039-5ee8d5a992ae", "1487e501-e65f-4408-83d3-e7e0048f2c30" ], "Users": [ "e288c458-7c68-474e-90ff-e466b276e53b", "02dae8af-29ff-4520-9fd4-da1a3b2edeb3" ] } ], "StartDate": "2025-05-23T21:50:55.5959647+00:00", "DueDate": "2025-05-23T21:50:55.5959647+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "3a545960-e2f3-46f3-98db-b1ef7dc50f71": "97803ffb-ff8f-46ae-95e1-9ded8be7ace4", "3fb268a6-18bc-43fb-af77-ed749fd0dca1": "91597a0c-1d8c-4931-8042-9c0bb8af315b" }, "HasUpdates": true, "Modified": "2025-05-23T21:50:55.5959647+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-05-23T21:50:55.5959647+00:00" }, "LastComment": "2025-05-23T21:50:55.5959647+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "c9b3c4e8-cda4-4962-9687-52567ede6002", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "e749946d-ff62-47ad-8469-e0d2c12979f0", "id": "0587f653-08a1-4dda-aa9b-e82e0e591c5c", "ConfigId": "5eb6b78c-ae1a-456c-a7f7-95239e207e68" } ]