POST api/workplan/{id}/tasks
Add Task
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Work Plan Id |
globally unique identifier |
Required |
Body Parameters
TasksRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| WorkTypeId | globally unique identifier |
None. |
|
| ParentTaskId | globally unique identifier |
None. |
|
| Integration | TaskIntegrationInfo |
None. |
|
| Assignments | Dictionary of globally unique identifier [key] and decimal number [value] |
None. |
|
| ProcessAssignments | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"WorkTypeId": "5c4f91d1-943f-4d0c-8494-d834abb83f48",
"ParentTaskId": "fa62520a-d909-48bf-8de2-25dd2991c6d9",
"Integration": {
"IntegrationId": "25eafbe4-e4ca-401e-b751-917d8e78f646",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"97908fb5-7b3d-422f-a017-0ad414a946fc": 2.0,
"fb5c713e-b694-4912-81ba-865319440046": 4.0
},
"ProcessAssignments": true
}
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": "05ac6cc9-377a-46b4-966c-90a51dd4e94d",
"Name": "sample string 1",
"Created": "2026-07-30T20:03:20.2344937+00:00",
"Modified": "2026-07-30T20:03:20.2344937+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ded9f195-0032-41e3-928f-36e215780c2e",
"55ec1998-78ce-42f0-a728-f309e7666830"
],
"NonLaborAssignments": [
{
"Id": "20d8a461-e721-44d5-a907-b98a258b2bdd",
"ResourceId": "aac023a5-af44-41e6-a102-e6d2dddc737a",
"Quantity": 3.0
},
{
"Id": "20d8a461-e721-44d5-a907-b98a258b2bdd",
"ResourceId": "aac023a5-af44-41e6-a102-e6d2dddc737a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b4b55e83-64c8-4360-9f5c-e8382e827b57",
"Type": 0,
"ResourceId": "bbd6d389-ff39-4ea6-9842-043abb7ff04a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "b4b55e83-64c8-4360-9f5c-e8382e827b57",
"Type": 0,
"ResourceId": "bbd6d389-ff39-4ea6-9842-043abb7ff04a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "80343a8e-5705-46fd-bb53-958b132397a9",
"WorkTypeParentId": "dac8bb0f-d826-4066-846f-2a2d2abe34d7",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "96ddb81e-f3d5-4471-a82c-ff053c9aabaf",
"UPN": "3a1f5d42-caac-4386-b7d9-be1589ecfef1",
"PostDate": "2026-07-30T20:03:20.2344937+00:00",
"Comment": "sample string 4",
"CC": [
"4907c5ba-276d-4527-bae1-cfe5245c422c",
"c73c4c60-a151-4b0e-b2c8-deadc50676cf"
],
"Users": [
"fa9b6d53-3b0e-482f-9d01-777f6d402ad6",
"b29f3bb5-daa3-491a-8d43-f532bae1db75"
]
},
{
"Id": "96ddb81e-f3d5-4471-a82c-ff053c9aabaf",
"UPN": "3a1f5d42-caac-4386-b7d9-be1589ecfef1",
"PostDate": "2026-07-30T20:03:20.2344937+00:00",
"Comment": "sample string 4",
"CC": [
"4907c5ba-276d-4527-bae1-cfe5245c422c",
"c73c4c60-a151-4b0e-b2c8-deadc50676cf"
],
"Users": [
"fa9b6d53-3b0e-482f-9d01-777f6d402ad6",
"b29f3bb5-daa3-491a-8d43-f532bae1db75"
]
}
],
"StartDate": "2026-07-30T20:03:20.2344937+00:00",
"DueDate": "2026-07-30T20:03:20.2344937+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"26d0e678-ac8f-422e-82ce-2df6d34ae584": "ad2851fb-fe1d-47b1-a535-bb42191a8ffc",
"b5c46002-afcf-4680-a367-3e19f4eb545f": "d48b660c-a7e2-46ef-a414-4ffee84f1d78"
},
"HasUpdates": true,
"Modified": "2026-07-30T20:03:20.2344937+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-30T20:03:20.2344937+00:00"
},
"LastComment": "2026-07-30T20:03:20.2344937+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "6aa7020e-2402-4bb2-af5c-36131df1d601",
"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": "bed43442-7f2f-4745-9821-f23c41103859",
"id": "e60369c3-90bb-4e77-ad50-a26896d5dc1c",
"ConfigId": "2cf30e28-8239-4b5c-9002-298f452ccd9a"
}