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": "0353d9aa-1598-4c7d-926b-7f4bfd958053",
"ParentTaskId": "981f3a7c-f8b4-4789-b763-3d6c4c3fc465",
"Integration": {
"IntegrationId": "2e79bfd5-543c-4652-af82-bfe3d5ec49d8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"4c25c0e1-5468-4107-9fcc-ccec7b50e9d9": 2.0,
"c360d456-4dda-4f31-88a8-7cf6efaefa6e": 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": "670f4e3b-db93-4b66-ba36-f10dd4a34a1f",
"Name": "sample string 1",
"Created": "2026-07-15T10:02:09.3619894+00:00",
"Modified": "2026-07-15T10:02:09.3619894+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"29ce1f01-419d-4118-9b40-f9d2fc91ce42",
"7f08a600-73f2-4fae-b83b-538c128f14ff"
],
"NonLaborAssignments": [
{
"Id": "9294287c-e05a-4691-bc41-c2f637ecff58",
"ResourceId": "b267910e-ffb2-4586-94a3-793319304d61",
"Quantity": 3.0
},
{
"Id": "9294287c-e05a-4691-bc41-c2f637ecff58",
"ResourceId": "b267910e-ffb2-4586-94a3-793319304d61",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "69691295-2697-4c34-a48a-9e27d2ea8d87",
"Type": 0,
"ResourceId": "a4ec4338-71a1-4b66-a8ec-52b7c757175f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "69691295-2697-4c34-a48a-9e27d2ea8d87",
"Type": 0,
"ResourceId": "a4ec4338-71a1-4b66-a8ec-52b7c757175f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "f9972e2a-9de9-4253-811f-c0bcf8ce1101",
"WorkTypeParentId": "9fa1a068-d005-44c0-b888-f6dc2c9edd42",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8b94f477-c5cf-4cae-87f1-37f57ec3d0a2",
"UPN": "30475ba8-13ac-4f3b-8e0e-31c147104b3e",
"PostDate": "2026-07-15T10:02:09.3619894+00:00",
"Comment": "sample string 4",
"CC": [
"818f9781-7245-41f1-ba0c-df8275486cb0",
"f82948df-a241-446f-b6cd-8a907d33d800"
],
"Users": [
"bbfb9311-c744-4f42-9e9f-c335cdc4906d",
"a7fc0386-78d1-4964-a7b8-ef63163069e9"
]
},
{
"Id": "8b94f477-c5cf-4cae-87f1-37f57ec3d0a2",
"UPN": "30475ba8-13ac-4f3b-8e0e-31c147104b3e",
"PostDate": "2026-07-15T10:02:09.3619894+00:00",
"Comment": "sample string 4",
"CC": [
"818f9781-7245-41f1-ba0c-df8275486cb0",
"f82948df-a241-446f-b6cd-8a907d33d800"
],
"Users": [
"bbfb9311-c744-4f42-9e9f-c335cdc4906d",
"a7fc0386-78d1-4964-a7b8-ef63163069e9"
]
}
],
"StartDate": "2026-07-15T10:02:09.3619894+00:00",
"DueDate": "2026-07-15T10:02:09.3619894+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"5536ecc6-dbbd-407f-936b-132cbfa5faa0": "7c3faa33-dbce-438c-9372-6ec2b97a2385",
"f2556c99-acf7-4dcc-aee2-e3c69c45a818": "7d8e8672-a9e2-4d62-be1d-e35530e9ad1b"
},
"HasUpdates": true,
"Modified": "2026-07-15T10:02:09.3619894+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-15T10:02:09.3619894+00:00"
},
"LastComment": "2026-07-15T10:02:09.3619894+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9aacfbbf-0fed-4437-8b72-2c186e6cf9f8",
"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": "ceb1138a-1025-4878-a67d-6cb231db289f",
"id": "5011f596-81ea-4a1b-bfa6-7e54f5e17ae9",
"ConfigId": "9a44a0b2-7059-4be7-843a-22790c73c1af"
}