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": "3ebf0fdd-8e0e-455b-8ee2-46f59beabec3",
"Name": "sample string 1",
"Created": "2026-02-01T14:04:48.1055199+00:00",
"Modified": "2026-02-01T14:04:48.1055199+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"39bdb019-dbdc-4712-97f5-c92e73fbe171",
"b7627e78-00e0-4895-a511-9c612f87b2df"
],
"NonLaborAssignments": [
{
"Id": "f0f7fbb5-8758-4c88-9833-9239080ef0d9",
"ResourceId": "ba483c35-54cf-40fb-ba8d-d056e6f67fd9",
"Quantity": 3.0
},
{
"Id": "f0f7fbb5-8758-4c88-9833-9239080ef0d9",
"ResourceId": "ba483c35-54cf-40fb-ba8d-d056e6f67fd9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "10ef0374-e5c1-451a-907e-73f9a4b4fa65",
"Type": 0,
"ResourceId": "6660fc39-b4f3-4425-826e-9ff97155b349",
"Units": 3.0
},
{
"Id": "10ef0374-e5c1-451a-907e-73f9a4b4fa65",
"Type": 0,
"ResourceId": "6660fc39-b4f3-4425-826e-9ff97155b349",
"Units": 3.0
}
],
"ParentId": "a90ef532-0c2e-4765-acf7-b785f80c1f1d",
"WorkTypeParentId": "dd790226-25bf-45e2-8d5b-b78c63032ca8",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3f849445-5df0-4a99-9ef4-7a10195c2634",
"UPN": "8899940d-c3c6-4ab2-9e82-d3590a09a5b8",
"PostDate": "2026-02-01T14:04:48.1055199+00:00",
"Comment": "sample string 4",
"CC": [
"ba0b06a6-8c8f-4d43-a111-3b7c21d2e2d2",
"9a0655c9-110f-4361-9fc3-d8f7bc2c50b3"
],
"Users": [
"7c9a5507-6a04-41aa-a1f6-0252a353c967",
"c2890f0f-decf-423a-af96-551b0552b603"
]
},
{
"Id": "3f849445-5df0-4a99-9ef4-7a10195c2634",
"UPN": "8899940d-c3c6-4ab2-9e82-d3590a09a5b8",
"PostDate": "2026-02-01T14:04:48.1055199+00:00",
"Comment": "sample string 4",
"CC": [
"ba0b06a6-8c8f-4d43-a111-3b7c21d2e2d2",
"9a0655c9-110f-4361-9fc3-d8f7bc2c50b3"
],
"Users": [
"7c9a5507-6a04-41aa-a1f6-0252a353c967",
"c2890f0f-decf-423a-af96-551b0552b603"
]
}
],
"StartDate": "2026-02-01T14:04:48.1055199+00:00",
"DueDate": "2026-02-01T14:04:48.1055199+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ec229127-8e19-4fce-8131-f9ac135e5a97": "8beb9030-f640-43f8-8967-fa45aeb0e5b6",
"cc38f32a-5157-4bdb-b917-74c85c355b3c": "0b35177c-1543-48ec-a043-3c496f0b9dc1"
},
"HasUpdates": true,
"Modified": "2026-02-01T14:04:48.1055199+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-02-01T14:04:48.1055199+00:00"
},
"LastComment": "2026-02-01T14:04:48.1055199+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b8a2e104-aa40-4be8-aa4a-dce07641246b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "0760fdb2-da59-4c5c-8f1d-82dc49609882",
"id": "c3dad903-d611-4eb6-b26f-a653361ec753",
"ConfigId": "69c72fb4-5f10-47c6-a904-034b87707aa2"
},
{
"WorkTypeId": "3ebf0fdd-8e0e-455b-8ee2-46f59beabec3",
"Name": "sample string 1",
"Created": "2026-02-01T14:04:48.1055199+00:00",
"Modified": "2026-02-01T14:04:48.1055199+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"39bdb019-dbdc-4712-97f5-c92e73fbe171",
"b7627e78-00e0-4895-a511-9c612f87b2df"
],
"NonLaborAssignments": [
{
"Id": "f0f7fbb5-8758-4c88-9833-9239080ef0d9",
"ResourceId": "ba483c35-54cf-40fb-ba8d-d056e6f67fd9",
"Quantity": 3.0
},
{
"Id": "f0f7fbb5-8758-4c88-9833-9239080ef0d9",
"ResourceId": "ba483c35-54cf-40fb-ba8d-d056e6f67fd9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "10ef0374-e5c1-451a-907e-73f9a4b4fa65",
"Type": 0,
"ResourceId": "6660fc39-b4f3-4425-826e-9ff97155b349",
"Units": 3.0
},
{
"Id": "10ef0374-e5c1-451a-907e-73f9a4b4fa65",
"Type": 0,
"ResourceId": "6660fc39-b4f3-4425-826e-9ff97155b349",
"Units": 3.0
}
],
"ParentId": "a90ef532-0c2e-4765-acf7-b785f80c1f1d",
"WorkTypeParentId": "dd790226-25bf-45e2-8d5b-b78c63032ca8",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3f849445-5df0-4a99-9ef4-7a10195c2634",
"UPN": "8899940d-c3c6-4ab2-9e82-d3590a09a5b8",
"PostDate": "2026-02-01T14:04:48.1055199+00:00",
"Comment": "sample string 4",
"CC": [
"ba0b06a6-8c8f-4d43-a111-3b7c21d2e2d2",
"9a0655c9-110f-4361-9fc3-d8f7bc2c50b3"
],
"Users": [
"7c9a5507-6a04-41aa-a1f6-0252a353c967",
"c2890f0f-decf-423a-af96-551b0552b603"
]
},
{
"Id": "3f849445-5df0-4a99-9ef4-7a10195c2634",
"UPN": "8899940d-c3c6-4ab2-9e82-d3590a09a5b8",
"PostDate": "2026-02-01T14:04:48.1055199+00:00",
"Comment": "sample string 4",
"CC": [
"ba0b06a6-8c8f-4d43-a111-3b7c21d2e2d2",
"9a0655c9-110f-4361-9fc3-d8f7bc2c50b3"
],
"Users": [
"7c9a5507-6a04-41aa-a1f6-0252a353c967",
"c2890f0f-decf-423a-af96-551b0552b603"
]
}
],
"StartDate": "2026-02-01T14:04:48.1055199+00:00",
"DueDate": "2026-02-01T14:04:48.1055199+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ec229127-8e19-4fce-8131-f9ac135e5a97": "8beb9030-f640-43f8-8967-fa45aeb0e5b6",
"cc38f32a-5157-4bdb-b917-74c85c355b3c": "0b35177c-1543-48ec-a043-3c496f0b9dc1"
},
"HasUpdates": true,
"Modified": "2026-02-01T14:04:48.1055199+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-02-01T14:04:48.1055199+00:00"
},
"LastComment": "2026-02-01T14:04:48.1055199+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b8a2e104-aa40-4be8-aa4a-dce07641246b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "0760fdb2-da59-4c5c-8f1d-82dc49609882",
"id": "c3dad903-d611-4eb6-b26f-a653361ec753",
"ConfigId": "69c72fb4-5f10-47c6-a904-034b87707aa2"
}
]