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": "30ee77ca-1856-4836-8adb-687f593e0b41",
"ParentTaskId": "05060171-242b-4444-98ad-0c0b9bc45b00",
"Integration": {
"IntegrationId": "5a01bbef-08d7-400f-98be-b5f9d5ac2a0e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"94332370-14f1-47e8-8b44-30fa3d1187a9": 2.0,
"43b39027-81cb-44b1-b82a-5eca19974340": 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": "029a54b4-9c5e-4aa9-ae12-b23049aab6fd",
"Name": "sample string 1",
"Created": "2026-10-13T18:08:47.3042404+00:00",
"Modified": "2026-10-13T18:08:47.3042404+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d4a3a999-c27b-4227-8735-d025030edf00",
"07143e0b-fbab-42ed-95c3-30a2a09ccc96"
],
"NonLaborAssignments": [
{
"Id": "c4f89060-8484-4ca2-ab2d-abf8b3898f7e",
"ResourceId": "949fb319-4f3d-4730-8670-b230e3f6169d",
"Quantity": 3.0
},
{
"Id": "c4f89060-8484-4ca2-ab2d-abf8b3898f7e",
"ResourceId": "949fb319-4f3d-4730-8670-b230e3f6169d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "529c4664-c199-417e-822b-26a08020f746",
"Type": 0,
"ResourceId": "537d0d63-4388-4929-87be-5c1a8f6172f3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7c8324b1-7b79-4b54-b03b-93c20b612fba",
"Start": "2026-10-13T18:08:47.3042404+00:00",
"Due": "2026-10-13T18:08:47.3042404+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7c8324b1-7b79-4b54-b03b-93c20b612fba",
"Start": "2026-10-13T18:08:47.3042404+00:00",
"Due": "2026-10-13T18:08:47.3042404+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "529c4664-c199-417e-822b-26a08020f746",
"Type": 0,
"ResourceId": "537d0d63-4388-4929-87be-5c1a8f6172f3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7c8324b1-7b79-4b54-b03b-93c20b612fba",
"Start": "2026-10-13T18:08:47.3042404+00:00",
"Due": "2026-10-13T18:08:47.3042404+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7c8324b1-7b79-4b54-b03b-93c20b612fba",
"Start": "2026-10-13T18:08:47.3042404+00:00",
"Due": "2026-10-13T18:08:47.3042404+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "dca9e08f-9fcf-4881-ba45-071428aae166",
"WorkTypeParentId": "06c1f2cc-9893-4181-a25e-948597d85528",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3ce860f5-41ad-4724-b0c6-c01d7913fe82",
"UPN": "f4d443d8-3b06-4423-b4cf-52aec791a6cb",
"PostDate": "2026-10-13T18:08:47.3042404+00:00",
"Comment": "sample string 4",
"CC": [
"974766c9-9030-4124-b720-5ecfe25cc379",
"52bfbf91-cde7-4109-aa2d-82e4ac7273b2"
],
"Users": [
"7ec00926-f78a-43b1-a4f1-6f59c02c1515",
"14076a0f-3baa-4ce1-8312-27a7acbedbdc"
]
},
{
"Id": "3ce860f5-41ad-4724-b0c6-c01d7913fe82",
"UPN": "f4d443d8-3b06-4423-b4cf-52aec791a6cb",
"PostDate": "2026-10-13T18:08:47.3042404+00:00",
"Comment": "sample string 4",
"CC": [
"974766c9-9030-4124-b720-5ecfe25cc379",
"52bfbf91-cde7-4109-aa2d-82e4ac7273b2"
],
"Users": [
"7ec00926-f78a-43b1-a4f1-6f59c02c1515",
"14076a0f-3baa-4ce1-8312-27a7acbedbdc"
]
}
],
"StartDate": "2026-10-13T18:08:47.3042404+00:00",
"DueDate": "2026-10-13T18:08:47.3042404+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"633605ab-781f-4ba0-9eb4-749e224e27c1": "f698f3f5-7cc0-4a2f-bdef-99daae633760",
"6e2f8fed-aeae-4d98-8d7f-65e8af4bf8aa": "028c0ce8-4487-4483-8472-b30cbf06d583"
},
"HasUpdates": true,
"Modified": "2026-10-13T18:08:47.3042404+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-13T18:08:47.3042404+00:00"
},
"LastComment": "2026-10-13T18:08:47.3042404+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5abc834d-93e2-4f7f-91e3-62dbda751d76",
"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": "08653841-a730-4a46-bd8e-5e8b9e4103f0",
"id": "97d8a11a-a98f-40cb-be1e-1ef6db25e001",
"ConfigId": "029ef03b-1460-4524-b508-d98390544d34"
}