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": "28db2d5d-f498-4d1c-8cdf-c27b874d608b",
"ParentTaskId": "a9ee2e15-277f-4305-84a2-a271dab73817",
"Integration": {
"IntegrationId": "e21bcfb2-fad9-410e-98d3-117a4aa66df4",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"ae76f405-fbe2-4686-a7f8-3b9de87d045a": 2.0,
"71473edc-c56c-4386-ab21-49eb058b9396": 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": "023264fd-b13f-4a59-aa16-98da4f954ec1",
"Name": "sample string 1",
"Created": "2026-09-27T10:15:34.3910556+00:00",
"Modified": "2026-09-27T10:15:34.3910556+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"79007519-4338-418c-afa2-e298dfe1de7a",
"6c1e2306-8f75-4522-b84b-ff096c6a4087"
],
"NonLaborAssignments": [
{
"Id": "0e12526f-c658-4730-b2fa-ee48b966c085",
"ResourceId": "a86a5ada-9577-46f9-b662-b52dcf6dac33",
"Quantity": 3.0
},
{
"Id": "0e12526f-c658-4730-b2fa-ee48b966c085",
"ResourceId": "a86a5ada-9577-46f9-b662-b52dcf6dac33",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1fe6ff78-0d73-43c6-9239-9729ec837e88",
"Type": 0,
"ResourceId": "00be9be1-e5bd-44ce-9fb2-99a7a681566e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9344deb1-b859-4d14-b555-1bee5735313d",
"Start": "2026-09-27T10:15:34.4066872+00:00",
"Due": "2026-09-27T10:15:34.4066872+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9344deb1-b859-4d14-b555-1bee5735313d",
"Start": "2026-09-27T10:15:34.4066872+00:00",
"Due": "2026-09-27T10:15:34.4066872+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "1fe6ff78-0d73-43c6-9239-9729ec837e88",
"Type": 0,
"ResourceId": "00be9be1-e5bd-44ce-9fb2-99a7a681566e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9344deb1-b859-4d14-b555-1bee5735313d",
"Start": "2026-09-27T10:15:34.4066872+00:00",
"Due": "2026-09-27T10:15:34.4066872+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9344deb1-b859-4d14-b555-1bee5735313d",
"Start": "2026-09-27T10:15:34.4066872+00:00",
"Due": "2026-09-27T10:15:34.4066872+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "334ee82e-2089-4a30-b90d-1022a3de83b2",
"WorkTypeParentId": "bc39e6a1-3ab2-40a4-bb55-c3717dc20304",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "0382b9c6-abcb-495c-8025-cca0ca01de05",
"UPN": "edf12f1d-00c3-40b2-93c8-6999a7c6963e",
"PostDate": "2026-09-27T10:15:34.4066872+00:00",
"Comment": "sample string 4",
"CC": [
"59fc5711-7a43-44b5-90c2-6748492c57ed",
"b675f499-1365-477a-935d-e701737f8a83"
],
"Users": [
"0227dc0b-341f-4cf1-a964-b531eb3cd365",
"76885843-2e9b-451d-a054-0256487ccb2d"
]
},
{
"Id": "0382b9c6-abcb-495c-8025-cca0ca01de05",
"UPN": "edf12f1d-00c3-40b2-93c8-6999a7c6963e",
"PostDate": "2026-09-27T10:15:34.4066872+00:00",
"Comment": "sample string 4",
"CC": [
"59fc5711-7a43-44b5-90c2-6748492c57ed",
"b675f499-1365-477a-935d-e701737f8a83"
],
"Users": [
"0227dc0b-341f-4cf1-a964-b531eb3cd365",
"76885843-2e9b-451d-a054-0256487ccb2d"
]
}
],
"StartDate": "2026-09-27T10:15:34.4066872+00:00",
"DueDate": "2026-09-27T10:15:34.4066872+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4667efe1-18ea-415d-b4ba-075ea444564f": "f19610e4-b1d6-40ba-811e-876509aea118",
"32b0b4cc-b5e7-4941-b3b3-b29f1fcda618": "68be4a4b-f7d7-4514-b19c-26e83a7d4bcf"
},
"HasUpdates": true,
"Modified": "2026-09-27T10:15:34.4066872+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-09-27T10:15:34.4066872+00:00"
},
"LastComment": "2026-09-27T10:15:34.4066872+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ec273561-e097-4262-97b9-78b717b85f1b",
"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": "43fe7260-d328-4536-b669-f59dfe5852bc",
"id": "e21a3d8e-4b10-4296-b061-37c0c67ed7a3",
"ConfigId": "6ab2e7ae-3848-442b-9786-d6b93431208c"
}