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. |
|
| 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": "dd6d01d5-3d19-4aa1-8abd-0ca9af136697",
"Name": "sample string 1",
"Created": "2024-10-18T08:35:46.7033419+00:00",
"Modified": "2024-10-18T08:35:46.7033419+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c6975ff1-10e5-46a2-90a1-1bd8710c36f3",
"f30af0f1-b428-4ec2-a665-f9d8c5208f99"
],
"Assignments": [
{
"Id": "63436f77-26af-4446-ab8e-d9ec3406b89a",
"Type": 0,
"ResourceId": "1281870b-4603-45c3-85c1-30f97530f65a",
"Units": 3.0
},
{
"Id": "63436f77-26af-4446-ab8e-d9ec3406b89a",
"Type": 0,
"ResourceId": "1281870b-4603-45c3-85c1-30f97530f65a",
"Units": 3.0
}
],
"ParentId": "40cd8dd9-3af9-40bc-9a07-8723c031e6b6",
"WorkTypeParentId": "0fd5fdd1-f24a-4bcf-b701-baea403584b7",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b4d6f678-ce34-48de-953a-1f789ad33881",
"UPN": "72f2c1bb-c462-43cb-9196-15a9ae647d7c",
"PostDate": "2024-10-18T08:35:46.7033419+00:00",
"Comment": "sample string 4",
"CC": [
"6251d56b-9723-4140-9c16-77603937ec56",
"8c7e0453-2867-40ba-a0c8-2f29ae2412ce"
],
"Users": [
"2b03ce17-d09d-423c-abba-ba7d613728c0",
"a95ade69-bf62-470f-9ebc-c8f9226d93f4"
]
},
{
"Id": "b4d6f678-ce34-48de-953a-1f789ad33881",
"UPN": "72f2c1bb-c462-43cb-9196-15a9ae647d7c",
"PostDate": "2024-10-18T08:35:46.7033419+00:00",
"Comment": "sample string 4",
"CC": [
"6251d56b-9723-4140-9c16-77603937ec56",
"8c7e0453-2867-40ba-a0c8-2f29ae2412ce"
],
"Users": [
"2b03ce17-d09d-423c-abba-ba7d613728c0",
"a95ade69-bf62-470f-9ebc-c8f9226d93f4"
]
}
],
"StartDate": "2024-10-18T08:35:46.7033419+00:00",
"DueDate": "2024-10-18T08:35:46.7033419+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"94c061ef-936f-4d36-bcf7-54cbc43fd961": "79787ab8-4e12-41fd-bae4-ab5b21759e26",
"7b87cf4c-5371-499d-a3bc-673d29374df7": "b4aa052e-c663-47f1-a2ee-db409929430b"
},
"HasUpdates": true,
"Modified": "2024-10-18T08:35:46.7033419+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": "2024-10-18T08:35:46.7033419+00:00"
},
"LastComment": "2024-10-18T08:35:46.7033419+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e041843c-b312-4ead-958b-cba7d567a382",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "3c00d1ef-196c-4950-928e-3e8edc4df4b0",
"id": "b3681918-d4dd-4f96-bb1a-6c2b9e972fe8",
"ConfigId": "ebb885ce-d65e-4a8b-807e-2a1edf9cc7de"
},
{
"WorkTypeId": "dd6d01d5-3d19-4aa1-8abd-0ca9af136697",
"Name": "sample string 1",
"Created": "2024-10-18T08:35:46.7033419+00:00",
"Modified": "2024-10-18T08:35:46.7033419+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c6975ff1-10e5-46a2-90a1-1bd8710c36f3",
"f30af0f1-b428-4ec2-a665-f9d8c5208f99"
],
"Assignments": [
{
"Id": "63436f77-26af-4446-ab8e-d9ec3406b89a",
"Type": 0,
"ResourceId": "1281870b-4603-45c3-85c1-30f97530f65a",
"Units": 3.0
},
{
"Id": "63436f77-26af-4446-ab8e-d9ec3406b89a",
"Type": 0,
"ResourceId": "1281870b-4603-45c3-85c1-30f97530f65a",
"Units": 3.0
}
],
"ParentId": "40cd8dd9-3af9-40bc-9a07-8723c031e6b6",
"WorkTypeParentId": "0fd5fdd1-f24a-4bcf-b701-baea403584b7",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b4d6f678-ce34-48de-953a-1f789ad33881",
"UPN": "72f2c1bb-c462-43cb-9196-15a9ae647d7c",
"PostDate": "2024-10-18T08:35:46.7033419+00:00",
"Comment": "sample string 4",
"CC": [
"6251d56b-9723-4140-9c16-77603937ec56",
"8c7e0453-2867-40ba-a0c8-2f29ae2412ce"
],
"Users": [
"2b03ce17-d09d-423c-abba-ba7d613728c0",
"a95ade69-bf62-470f-9ebc-c8f9226d93f4"
]
},
{
"Id": "b4d6f678-ce34-48de-953a-1f789ad33881",
"UPN": "72f2c1bb-c462-43cb-9196-15a9ae647d7c",
"PostDate": "2024-10-18T08:35:46.7033419+00:00",
"Comment": "sample string 4",
"CC": [
"6251d56b-9723-4140-9c16-77603937ec56",
"8c7e0453-2867-40ba-a0c8-2f29ae2412ce"
],
"Users": [
"2b03ce17-d09d-423c-abba-ba7d613728c0",
"a95ade69-bf62-470f-9ebc-c8f9226d93f4"
]
}
],
"StartDate": "2024-10-18T08:35:46.7033419+00:00",
"DueDate": "2024-10-18T08:35:46.7033419+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"94c061ef-936f-4d36-bcf7-54cbc43fd961": "79787ab8-4e12-41fd-bae4-ab5b21759e26",
"7b87cf4c-5371-499d-a3bc-673d29374df7": "b4aa052e-c663-47f1-a2ee-db409929430b"
},
"HasUpdates": true,
"Modified": "2024-10-18T08:35:46.7033419+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": "2024-10-18T08:35:46.7033419+00:00"
},
"LastComment": "2024-10-18T08:35:46.7033419+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e041843c-b312-4ead-958b-cba7d567a382",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "3c00d1ef-196c-4950-928e-3e8edc4df4b0",
"id": "b3681918-d4dd-4f96-bb1a-6c2b9e972fe8",
"ConfigId": "ebb885ce-d65e-4a8b-807e-2a1edf9cc7de"
}
]