GET api/workplan/{id}/tasks?HasUpdates={HasUpdates}&FilterField={FilterField}&FilterValue={FilterValue}&BuiltInField={BuiltInField}
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 |
|
| BuiltInField | boolean |
Default value is False |
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. |
|
| LinkedFileIds | Collection of string |
None. |
|
| LinkedLinkIds | Collection of string |
None. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"WorkTypeId": "26074695-9427-458d-97f4-c3276190d5e3",
"Name": "sample string 1",
"Created": "2026-07-01T16:16:21.5232107+00:00",
"Modified": "2026-07-01T16:16:21.5232107+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e9a4dd4c-3ce8-4fde-ac4d-b26b8d408d24",
"7fb157a7-c0d6-4b31-8f0a-d96dc6eb6985"
],
"NonLaborAssignments": [
{
"Id": "4d498906-eb4b-4c95-aa3d-c5bebad6d769",
"ResourceId": "b6575c39-5b90-4deb-b6a7-3b65ffc3b175",
"Quantity": 3.0
},
{
"Id": "4d498906-eb4b-4c95-aa3d-c5bebad6d769",
"ResourceId": "b6575c39-5b90-4deb-b6a7-3b65ffc3b175",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7369888d-274d-45d9-976a-f0d456b35be5",
"Type": 0,
"ResourceId": "b48966eb-caf5-462a-9c1f-480abe8551b1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "7369888d-274d-45d9-976a-f0d456b35be5",
"Type": 0,
"ResourceId": "b48966eb-caf5-462a-9c1f-480abe8551b1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "278dc26a-f769-4886-aaba-a2bc0fc2e9cf",
"WorkTypeParentId": "afad2f1f-3e75-4cff-bd2a-bc1aacf5695e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "aeb01dcf-afb2-43c7-8400-cc35e963a286",
"UPN": "508a86f1-39e4-4539-bf87-b03275301cf9",
"PostDate": "2026-07-01T16:16:21.5232107+00:00",
"Comment": "sample string 4",
"CC": [
"5450fea3-8f63-4d02-a3c8-0aff8451d9f8",
"26e411b7-e6b5-4bf3-aa39-b3c7fe2bf7c2"
],
"Users": [
"6f92ed3b-b5b5-4c35-9dd1-84f245c023b4",
"4d130dd7-ae36-47d7-9958-35290a6e1abf"
]
},
{
"Id": "aeb01dcf-afb2-43c7-8400-cc35e963a286",
"UPN": "508a86f1-39e4-4539-bf87-b03275301cf9",
"PostDate": "2026-07-01T16:16:21.5232107+00:00",
"Comment": "sample string 4",
"CC": [
"5450fea3-8f63-4d02-a3c8-0aff8451d9f8",
"26e411b7-e6b5-4bf3-aa39-b3c7fe2bf7c2"
],
"Users": [
"6f92ed3b-b5b5-4c35-9dd1-84f245c023b4",
"4d130dd7-ae36-47d7-9958-35290a6e1abf"
]
}
],
"StartDate": "2026-07-01T16:16:21.5232107+00:00",
"DueDate": "2026-07-01T16:16:21.5232107+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"97048618-cd36-4337-ad42-21743ea99c70": "4e16e540-97b9-460e-a78b-1f4bb611eef5",
"cf54382a-3bf6-40d7-8256-ed87337c1f62": "c6f096c3-bd97-4f94-9bbc-676f278924fe"
},
"HasUpdates": true,
"Modified": "2026-07-01T16:16:21.5232107+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": "2026-07-01T16:16:21.5232107+00:00"
},
"LastComment": "2026-07-01T16:16:21.5232107+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9ab878bf-47a8-43a8-a20b-95ae0f2d0e11",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"LinkedFileIds": [
"sample string 1",
"sample string 2"
],
"LinkedLinkIds": [
"sample string 1",
"sample string 2"
],
"WorkPlanId": "5d15ed8d-d95d-4361-ae8b-95e784732b21",
"id": "7051c300-4188-49cc-9c20-e478bea95aaf",
"ConfigId": "f91a6ad5-771c-4174-996e-546337884348"
},
{
"WorkTypeId": "26074695-9427-458d-97f4-c3276190d5e3",
"Name": "sample string 1",
"Created": "2026-07-01T16:16:21.5232107+00:00",
"Modified": "2026-07-01T16:16:21.5232107+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e9a4dd4c-3ce8-4fde-ac4d-b26b8d408d24",
"7fb157a7-c0d6-4b31-8f0a-d96dc6eb6985"
],
"NonLaborAssignments": [
{
"Id": "4d498906-eb4b-4c95-aa3d-c5bebad6d769",
"ResourceId": "b6575c39-5b90-4deb-b6a7-3b65ffc3b175",
"Quantity": 3.0
},
{
"Id": "4d498906-eb4b-4c95-aa3d-c5bebad6d769",
"ResourceId": "b6575c39-5b90-4deb-b6a7-3b65ffc3b175",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7369888d-274d-45d9-976a-f0d456b35be5",
"Type": 0,
"ResourceId": "b48966eb-caf5-462a-9c1f-480abe8551b1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "7369888d-274d-45d9-976a-f0d456b35be5",
"Type": 0,
"ResourceId": "b48966eb-caf5-462a-9c1f-480abe8551b1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "278dc26a-f769-4886-aaba-a2bc0fc2e9cf",
"WorkTypeParentId": "afad2f1f-3e75-4cff-bd2a-bc1aacf5695e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "aeb01dcf-afb2-43c7-8400-cc35e963a286",
"UPN": "508a86f1-39e4-4539-bf87-b03275301cf9",
"PostDate": "2026-07-01T16:16:21.5232107+00:00",
"Comment": "sample string 4",
"CC": [
"5450fea3-8f63-4d02-a3c8-0aff8451d9f8",
"26e411b7-e6b5-4bf3-aa39-b3c7fe2bf7c2"
],
"Users": [
"6f92ed3b-b5b5-4c35-9dd1-84f245c023b4",
"4d130dd7-ae36-47d7-9958-35290a6e1abf"
]
},
{
"Id": "aeb01dcf-afb2-43c7-8400-cc35e963a286",
"UPN": "508a86f1-39e4-4539-bf87-b03275301cf9",
"PostDate": "2026-07-01T16:16:21.5232107+00:00",
"Comment": "sample string 4",
"CC": [
"5450fea3-8f63-4d02-a3c8-0aff8451d9f8",
"26e411b7-e6b5-4bf3-aa39-b3c7fe2bf7c2"
],
"Users": [
"6f92ed3b-b5b5-4c35-9dd1-84f245c023b4",
"4d130dd7-ae36-47d7-9958-35290a6e1abf"
]
}
],
"StartDate": "2026-07-01T16:16:21.5232107+00:00",
"DueDate": "2026-07-01T16:16:21.5232107+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"97048618-cd36-4337-ad42-21743ea99c70": "4e16e540-97b9-460e-a78b-1f4bb611eef5",
"cf54382a-3bf6-40d7-8256-ed87337c1f62": "c6f096c3-bd97-4f94-9bbc-676f278924fe"
},
"HasUpdates": true,
"Modified": "2026-07-01T16:16:21.5232107+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": "2026-07-01T16:16:21.5232107+00:00"
},
"LastComment": "2026-07-01T16:16:21.5232107+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9ab878bf-47a8-43a8-a20b-95ae0f2d0e11",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"LinkedFileIds": [
"sample string 1",
"sample string 2"
],
"LinkedLinkIds": [
"sample string 1",
"sample string 2"
],
"WorkPlanId": "5d15ed8d-d95d-4361-ae8b-95e784732b21",
"id": "7051c300-4188-49cc-9c20-e478bea95aaf",
"ConfigId": "f91a6ad5-771c-4174-996e-546337884348"
}
]