GET api/workplan/{id}/tasks/{taskid}
Get task by id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Work Plan Id |
globally unique identifier |
Required |
| taskid | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
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": "d598e021-9ce3-46b3-8bf4-20989a9038ce",
"Name": "sample string 1",
"Created": "2026-05-01T22:04:21.143544+00:00",
"Modified": "2026-05-01T22:04:21.143544+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"cbed8185-2362-452e-8f4b-d3f261b89877",
"a0ee19c1-d327-47d5-903e-1244dc7a5d8e"
],
"NonLaborAssignments": [
{
"Id": "2c4bb55d-980a-4837-86d4-c99215e467d6",
"ResourceId": "cc11d8fa-b649-4ce3-a886-63a1f98dc045",
"Quantity": 3.0
},
{
"Id": "2c4bb55d-980a-4837-86d4-c99215e467d6",
"ResourceId": "cc11d8fa-b649-4ce3-a886-63a1f98dc045",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "491a081d-a2e8-4fed-8d1c-4aa5bcf913b7",
"Type": 0,
"ResourceId": "153df879-5d58-4cdc-a7e9-b3c4391b715b",
"Units": 3.0
},
{
"Id": "491a081d-a2e8-4fed-8d1c-4aa5bcf913b7",
"Type": 0,
"ResourceId": "153df879-5d58-4cdc-a7e9-b3c4391b715b",
"Units": 3.0
}
],
"ParentId": "10596b11-bd46-4eb7-973f-ecd383f5d3e9",
"WorkTypeParentId": "2b653c80-4517-4d9f-99a4-ad2858af0f5b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e9faf79b-aa84-4ccf-9033-e46c5727371a",
"UPN": "fb5495e9-71a5-45a1-9498-f7aa76410153",
"PostDate": "2026-05-01T22:04:21.143544+00:00",
"Comment": "sample string 4",
"CC": [
"a7f19728-53ed-478c-9ae1-7975295d2552",
"31c27d25-909b-42bc-bd6d-868e07ad9a63"
],
"Users": [
"fa726500-7901-4b69-aff0-79963c5ad4eb",
"2e24f10e-6b2e-4676-a29c-ef233e3dd484"
]
},
{
"Id": "e9faf79b-aa84-4ccf-9033-e46c5727371a",
"UPN": "fb5495e9-71a5-45a1-9498-f7aa76410153",
"PostDate": "2026-05-01T22:04:21.143544+00:00",
"Comment": "sample string 4",
"CC": [
"a7f19728-53ed-478c-9ae1-7975295d2552",
"31c27d25-909b-42bc-bd6d-868e07ad9a63"
],
"Users": [
"fa726500-7901-4b69-aff0-79963c5ad4eb",
"2e24f10e-6b2e-4676-a29c-ef233e3dd484"
]
}
],
"StartDate": "2026-05-01T22:04:21.143544+00:00",
"DueDate": "2026-05-01T22:04:21.143544+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"aac0974d-9910-4acc-89f3-e1ca7afd7fa4": "5d315c0e-0d3c-4111-ae11-40ed4ce7a000",
"c2e1c700-f5d0-481d-83e7-03c145d3131e": "0d11b3c6-2604-464b-90a7-a3f949e8168f"
},
"HasUpdates": true,
"Modified": "2026-05-01T22:04:21.143544+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-05-01T22:04:21.143544+00:00"
},
"LastComment": "2026-05-01T22:04:21.143544+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f30ac857-a736-4bc5-a556-dbefe5d33c5a",
"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": "116e071e-30ca-4e0e-b355-67e7f68fc554",
"id": "8788fbd3-24c9-40e2-96b3-b2f178552a44",
"ConfigId": "3171c8a9-a9ed-4280-807d-51b41d5ce6f7"
}