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": "c0d52ab7-0a8f-49af-bb3a-82889f5207af",
"ParentTaskId": "21824cdf-f83b-45b2-bcc7-2ef5f7279d8d",
"Integration": {
"IntegrationId": "2e787e73-879a-4b29-8da9-418a0822dd74",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"6f5276c6-2077-479c-b16f-9936dd1bf897": 2.0,
"b9811840-acfa-4901-b648-880c7fb5d798": 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": "9406693a-48a8-4a5c-a494-e7acdca68469",
"Name": "sample string 1",
"Created": "2026-10-18T21:55:08.0820485+00:00",
"Modified": "2026-10-18T21:55:08.0820485+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"a2978e99-7415-4375-bef6-8319abb9c90f",
"af545c77-e0ac-4eec-b443-6ea9e9be873d"
],
"NonLaborAssignments": [
{
"Id": "7d40d75d-500c-4263-9481-2e59a1938e80",
"ResourceId": "c27ee00d-1a6c-4143-86cf-4279471f067a",
"Quantity": 3.0
},
{
"Id": "7d40d75d-500c-4263-9481-2e59a1938e80",
"ResourceId": "c27ee00d-1a6c-4143-86cf-4279471f067a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "01dad85e-b148-41e4-81b2-c8f8fd01eba7",
"Type": 0,
"ResourceId": "d9c1a203-56ce-41c6-901b-c1fefdf76429",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "ce3b1181-accc-4788-8564-8aa627740014",
"Start": "2026-10-18T21:55:08.0820485+00:00",
"Due": "2026-10-18T21:55:08.0820485+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "ce3b1181-accc-4788-8564-8aa627740014",
"Start": "2026-10-18T21:55:08.0820485+00:00",
"Due": "2026-10-18T21:55:08.0820485+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "01dad85e-b148-41e4-81b2-c8f8fd01eba7",
"Type": 0,
"ResourceId": "d9c1a203-56ce-41c6-901b-c1fefdf76429",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "ce3b1181-accc-4788-8564-8aa627740014",
"Start": "2026-10-18T21:55:08.0820485+00:00",
"Due": "2026-10-18T21:55:08.0820485+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "ce3b1181-accc-4788-8564-8aa627740014",
"Start": "2026-10-18T21:55:08.0820485+00:00",
"Due": "2026-10-18T21:55:08.0820485+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "e2081dee-b8bc-4508-a72d-69854dfaef12",
"WorkTypeParentId": "df036961-346c-4560-ae65-0f16274e9356",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "78c0f751-008a-4461-b87d-4c2f8250d154",
"UPN": "3a763f98-565e-4045-b38a-4ff45c24a588",
"PostDate": "2026-10-18T21:55:08.0820485+00:00",
"Comment": "sample string 4",
"CC": [
"dfdcff7e-e43e-4a9e-a659-abb7561d92f9",
"abe63e30-9011-4c61-8ad6-4660abec62cc"
],
"Users": [
"b566314c-7da5-4615-a169-9131bd5d53b0",
"c794cb89-0ab0-4203-8a66-863e80703ae7"
]
},
{
"Id": "78c0f751-008a-4461-b87d-4c2f8250d154",
"UPN": "3a763f98-565e-4045-b38a-4ff45c24a588",
"PostDate": "2026-10-18T21:55:08.0820485+00:00",
"Comment": "sample string 4",
"CC": [
"dfdcff7e-e43e-4a9e-a659-abb7561d92f9",
"abe63e30-9011-4c61-8ad6-4660abec62cc"
],
"Users": [
"b566314c-7da5-4615-a169-9131bd5d53b0",
"c794cb89-0ab0-4203-8a66-863e80703ae7"
]
}
],
"StartDate": "2026-10-18T21:55:08.0820485+00:00",
"DueDate": "2026-10-18T21:55:08.0820485+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ca3a4721-a532-4aca-8ca6-0fe0899068c6": "66eeeaa5-fd20-4391-936c-44ee450b359e",
"d6504a34-24c2-4eb9-a0fc-7e36e2a9814a": "850a0d22-3076-4153-8952-c55aec6f5bd9"
},
"HasUpdates": true,
"Modified": "2026-10-18T21:55:08.0820485+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-10-18T21:55:08.0820485+00:00"
},
"LastComment": "2026-10-18T21:55:08.0820485+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "41704739-866e-4af3-bf60-88774442515e",
"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": "c1f231c4-8dda-445c-abbc-caf5b6875b51",
"id": "a1400de9-3e47-442c-af9b-03b12109649d",
"ConfigId": "444ca728-235f-4156-9343-d7744517bbb7"
}