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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"WorkTypeId": "54e2be29-761f-4b08-a5ac-feb4d86bc18c",
"Name": "sample string 1",
"Created": "2025-12-03T13:01:33.446611+00:00",
"Modified": "2025-12-03T13:01:33.446611+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"cca47da7-2db4-4b2b-b3d3-a42e82d13ce9",
"ee85d776-b560-4e96-b5a0-34f2fb150bf5"
],
"NonLaborAssignments": [
{
"Id": "f92ce1e8-7678-4d7b-843a-f5e7496c352b",
"ResourceId": "a3030abd-07d7-46ea-b822-c450074a458e",
"Quantity": 3.0
},
{
"Id": "f92ce1e8-7678-4d7b-843a-f5e7496c352b",
"ResourceId": "a3030abd-07d7-46ea-b822-c450074a458e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "713acb60-99c7-45c4-ad2a-c70014fcafd1",
"Type": 0,
"ResourceId": "4fa63d43-003e-43f2-b1af-9bb99ff9841a",
"Units": 3.0
},
{
"Id": "713acb60-99c7-45c4-ad2a-c70014fcafd1",
"Type": 0,
"ResourceId": "4fa63d43-003e-43f2-b1af-9bb99ff9841a",
"Units": 3.0
}
],
"ParentId": "a28f5713-3c2d-40cd-9349-445ad370015b",
"WorkTypeParentId": "4205403c-b01b-4395-a033-361dd6e7221e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ec9e8b7b-cb60-4c15-bf39-34e065889107",
"UPN": "ee6536f9-84ef-4926-b95b-5bc9b02a9f91",
"PostDate": "2025-12-03T13:01:33.446611+00:00",
"Comment": "sample string 4",
"CC": [
"bbc946e6-4619-46be-acea-6c9651c77316",
"dd2c16c2-afe5-4740-af72-d18a8a9a541c"
],
"Users": [
"23faf261-90b0-4f48-b06c-f5743e31fef3",
"4a635276-cdc2-47f1-896c-7bb270faa8fb"
]
},
{
"Id": "ec9e8b7b-cb60-4c15-bf39-34e065889107",
"UPN": "ee6536f9-84ef-4926-b95b-5bc9b02a9f91",
"PostDate": "2025-12-03T13:01:33.446611+00:00",
"Comment": "sample string 4",
"CC": [
"bbc946e6-4619-46be-acea-6c9651c77316",
"dd2c16c2-afe5-4740-af72-d18a8a9a541c"
],
"Users": [
"23faf261-90b0-4f48-b06c-f5743e31fef3",
"4a635276-cdc2-47f1-896c-7bb270faa8fb"
]
}
],
"StartDate": "2025-12-03T13:01:33.446611+00:00",
"DueDate": "2025-12-03T13:01:33.446611+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7a4ba028-73d1-4cbd-976e-d8b8c8025ec6": "097565e4-ad36-4c78-8756-a7dc8978addc",
"3e57e7f1-7151-4a7f-a370-74310f58571c": "9e1ab2a4-be4a-48d2-a87e-4d958b25503f"
},
"HasUpdates": true,
"Modified": "2025-12-03T13:01:33.446611+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-12-03T13:01:33.446611+00:00"
},
"LastComment": "2025-12-03T13:01:33.446611+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a2d88694-c325-4bc4-a8a6-87a174f3b1eb",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "6f89b8d2-d2f2-41d1-944e-9b102157abb7",
"id": "a760173b-69b6-4804-9041-97d0965c9907",
"ConfigId": "c2621214-6b55-47d7-a026-719813c57166"
},
{
"WorkTypeId": "54e2be29-761f-4b08-a5ac-feb4d86bc18c",
"Name": "sample string 1",
"Created": "2025-12-03T13:01:33.446611+00:00",
"Modified": "2025-12-03T13:01:33.446611+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"cca47da7-2db4-4b2b-b3d3-a42e82d13ce9",
"ee85d776-b560-4e96-b5a0-34f2fb150bf5"
],
"NonLaborAssignments": [
{
"Id": "f92ce1e8-7678-4d7b-843a-f5e7496c352b",
"ResourceId": "a3030abd-07d7-46ea-b822-c450074a458e",
"Quantity": 3.0
},
{
"Id": "f92ce1e8-7678-4d7b-843a-f5e7496c352b",
"ResourceId": "a3030abd-07d7-46ea-b822-c450074a458e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "713acb60-99c7-45c4-ad2a-c70014fcafd1",
"Type": 0,
"ResourceId": "4fa63d43-003e-43f2-b1af-9bb99ff9841a",
"Units": 3.0
},
{
"Id": "713acb60-99c7-45c4-ad2a-c70014fcafd1",
"Type": 0,
"ResourceId": "4fa63d43-003e-43f2-b1af-9bb99ff9841a",
"Units": 3.0
}
],
"ParentId": "a28f5713-3c2d-40cd-9349-445ad370015b",
"WorkTypeParentId": "4205403c-b01b-4395-a033-361dd6e7221e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ec9e8b7b-cb60-4c15-bf39-34e065889107",
"UPN": "ee6536f9-84ef-4926-b95b-5bc9b02a9f91",
"PostDate": "2025-12-03T13:01:33.446611+00:00",
"Comment": "sample string 4",
"CC": [
"bbc946e6-4619-46be-acea-6c9651c77316",
"dd2c16c2-afe5-4740-af72-d18a8a9a541c"
],
"Users": [
"23faf261-90b0-4f48-b06c-f5743e31fef3",
"4a635276-cdc2-47f1-896c-7bb270faa8fb"
]
},
{
"Id": "ec9e8b7b-cb60-4c15-bf39-34e065889107",
"UPN": "ee6536f9-84ef-4926-b95b-5bc9b02a9f91",
"PostDate": "2025-12-03T13:01:33.446611+00:00",
"Comment": "sample string 4",
"CC": [
"bbc946e6-4619-46be-acea-6c9651c77316",
"dd2c16c2-afe5-4740-af72-d18a8a9a541c"
],
"Users": [
"23faf261-90b0-4f48-b06c-f5743e31fef3",
"4a635276-cdc2-47f1-896c-7bb270faa8fb"
]
}
],
"StartDate": "2025-12-03T13:01:33.446611+00:00",
"DueDate": "2025-12-03T13:01:33.446611+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7a4ba028-73d1-4cbd-976e-d8b8c8025ec6": "097565e4-ad36-4c78-8756-a7dc8978addc",
"3e57e7f1-7151-4a7f-a370-74310f58571c": "9e1ab2a4-be4a-48d2-a87e-4d958b25503f"
},
"HasUpdates": true,
"Modified": "2025-12-03T13:01:33.446611+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-12-03T13:01:33.446611+00:00"
},
"LastComment": "2025-12-03T13:01:33.446611+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a2d88694-c325-4bc4-a8a6-87a174f3b1eb",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "6f89b8d2-d2f2-41d1-944e-9b102157abb7",
"id": "a760173b-69b6-4804-9041-97d0965c9907",
"ConfigId": "c2621214-6b55-47d7-a026-719813c57166"
}
]