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 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"WorkTypeId": "a50bdc9e-1210-4bb2-bcd2-651adc58cd84",
"Name": "sample string 1",
"Created": "2025-09-03T18:07:29.492786+00:00",
"Modified": "2025-09-03T18:07:29.492786+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"df5f2ce1-049e-4382-a65e-48f126cdad8b",
"b3c24581-9a23-4ab3-8e76-b89fbc7932ca"
],
"NonLaborAssignments": [
{
"Id": "320652fa-922a-440e-931a-b5ff46a4e4a5",
"ResourceId": "20f49ab3-46ab-4b62-99ef-b85813658fe3",
"Quantity": 3.0
},
{
"Id": "320652fa-922a-440e-931a-b5ff46a4e4a5",
"ResourceId": "20f49ab3-46ab-4b62-99ef-b85813658fe3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ad8df57c-b70d-4a11-93d2-0ef549c91338",
"Type": 0,
"ResourceId": "869eb5c6-5f93-41b6-947f-7a8f012845ab",
"Units": 3.0
},
{
"Id": "ad8df57c-b70d-4a11-93d2-0ef549c91338",
"Type": 0,
"ResourceId": "869eb5c6-5f93-41b6-947f-7a8f012845ab",
"Units": 3.0
}
],
"ParentId": "830bff6c-c9b4-4137-af9e-dd5932829c3b",
"WorkTypeParentId": "7f651233-bded-4ef7-a9ee-a6b64107cc20",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "2450c85a-c05f-44ca-980a-d6916e0283b2",
"UPN": "00456d43-240e-4771-8693-e22558b85620",
"PostDate": "2025-09-03T18:07:29.492786+00:00",
"Comment": "sample string 4",
"CC": [
"352f822c-5721-477b-b6fb-2faac875c81b",
"b830f2a1-a0b3-44e1-b4d7-a1dec38eb99c"
],
"Users": [
"b0fec702-82a0-4d0f-9ac3-7a8644d93a5d",
"337d37ab-2504-47c9-be84-20081f932580"
]
},
{
"Id": "2450c85a-c05f-44ca-980a-d6916e0283b2",
"UPN": "00456d43-240e-4771-8693-e22558b85620",
"PostDate": "2025-09-03T18:07:29.492786+00:00",
"Comment": "sample string 4",
"CC": [
"352f822c-5721-477b-b6fb-2faac875c81b",
"b830f2a1-a0b3-44e1-b4d7-a1dec38eb99c"
],
"Users": [
"b0fec702-82a0-4d0f-9ac3-7a8644d93a5d",
"337d37ab-2504-47c9-be84-20081f932580"
]
}
],
"StartDate": "2025-09-03T18:07:29.492786+00:00",
"DueDate": "2025-09-03T18:07:29.492786+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bad7eec4-5bff-490e-a183-03b0ee567314": "44f632ed-e13d-48e9-8e22-13a2c24c35f8",
"69524118-5193-4306-b6db-8f59b0768549": "6aa65314-a579-4e9b-8463-a23680a752e1"
},
"HasUpdates": true,
"Modified": "2025-09-03T18:07:29.492786+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-09-03T18:07:29.492786+00:00"
},
"LastComment": "2025-09-03T18:07:29.492786+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "424aa952-607f-4df7-b8a1-4bc251f16836",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "fc3c89d8-bd51-4ce0-8004-3b472abe4f8d",
"id": "17655b7e-5029-493f-9b24-639d6a684b00",
"ConfigId": "2e4a33bb-7688-4163-8a95-aae012f5ceb2"
},
{
"WorkTypeId": "a50bdc9e-1210-4bb2-bcd2-651adc58cd84",
"Name": "sample string 1",
"Created": "2025-09-03T18:07:29.492786+00:00",
"Modified": "2025-09-03T18:07:29.492786+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"df5f2ce1-049e-4382-a65e-48f126cdad8b",
"b3c24581-9a23-4ab3-8e76-b89fbc7932ca"
],
"NonLaborAssignments": [
{
"Id": "320652fa-922a-440e-931a-b5ff46a4e4a5",
"ResourceId": "20f49ab3-46ab-4b62-99ef-b85813658fe3",
"Quantity": 3.0
},
{
"Id": "320652fa-922a-440e-931a-b5ff46a4e4a5",
"ResourceId": "20f49ab3-46ab-4b62-99ef-b85813658fe3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ad8df57c-b70d-4a11-93d2-0ef549c91338",
"Type": 0,
"ResourceId": "869eb5c6-5f93-41b6-947f-7a8f012845ab",
"Units": 3.0
},
{
"Id": "ad8df57c-b70d-4a11-93d2-0ef549c91338",
"Type": 0,
"ResourceId": "869eb5c6-5f93-41b6-947f-7a8f012845ab",
"Units": 3.0
}
],
"ParentId": "830bff6c-c9b4-4137-af9e-dd5932829c3b",
"WorkTypeParentId": "7f651233-bded-4ef7-a9ee-a6b64107cc20",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "2450c85a-c05f-44ca-980a-d6916e0283b2",
"UPN": "00456d43-240e-4771-8693-e22558b85620",
"PostDate": "2025-09-03T18:07:29.492786+00:00",
"Comment": "sample string 4",
"CC": [
"352f822c-5721-477b-b6fb-2faac875c81b",
"b830f2a1-a0b3-44e1-b4d7-a1dec38eb99c"
],
"Users": [
"b0fec702-82a0-4d0f-9ac3-7a8644d93a5d",
"337d37ab-2504-47c9-be84-20081f932580"
]
},
{
"Id": "2450c85a-c05f-44ca-980a-d6916e0283b2",
"UPN": "00456d43-240e-4771-8693-e22558b85620",
"PostDate": "2025-09-03T18:07:29.492786+00:00",
"Comment": "sample string 4",
"CC": [
"352f822c-5721-477b-b6fb-2faac875c81b",
"b830f2a1-a0b3-44e1-b4d7-a1dec38eb99c"
],
"Users": [
"b0fec702-82a0-4d0f-9ac3-7a8644d93a5d",
"337d37ab-2504-47c9-be84-20081f932580"
]
}
],
"StartDate": "2025-09-03T18:07:29.492786+00:00",
"DueDate": "2025-09-03T18:07:29.492786+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bad7eec4-5bff-490e-a183-03b0ee567314": "44f632ed-e13d-48e9-8e22-13a2c24c35f8",
"69524118-5193-4306-b6db-8f59b0768549": "6aa65314-a579-4e9b-8463-a23680a752e1"
},
"HasUpdates": true,
"Modified": "2025-09-03T18:07:29.492786+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-09-03T18:07:29.492786+00:00"
},
"LastComment": "2025-09-03T18:07:29.492786+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "424aa952-607f-4df7-b8a1-4bc251f16836",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "fc3c89d8-bd51-4ce0-8004-3b472abe4f8d",
"id": "17655b7e-5029-493f-9b24-639d6a684b00",
"ConfigId": "2e4a33bb-7688-4163-8a95-aae012f5ceb2"
}
]