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": "6b0b7404-dfd8-41b3-8b4a-ed81dabbb864",
"ParentTaskId": "bbdbe870-727e-4467-b592-8026a5f74cd5",
"Integration": {
"IntegrationId": "87357df1-2fb0-4d07-a987-ceadd8067023",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"4304b089-70da-45bf-84ec-0e64759728f4": 2.0,
"ac16ee59-8583-489a-b968-ce3735a99208": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "7d57c60a-1535-49e0-bfbf-951411393658",
"Name": "sample string 1",
"Created": "2026-01-07T21:32:31.0799719+00:00",
"Modified": "2026-01-07T21:32:31.0799719+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"83c8c8b0-bb76-453e-853d-d3ad3edce12a",
"d4bf0b3a-fffc-45c3-9267-cf04a5419a4c"
],
"NonLaborAssignments": [
{
"Id": "54c061b8-0e7d-45b2-bc30-15fcefd4236b",
"ResourceId": "26e26c41-dc9a-4862-9954-1b786857f044",
"Quantity": 3.0
},
{
"Id": "54c061b8-0e7d-45b2-bc30-15fcefd4236b",
"ResourceId": "26e26c41-dc9a-4862-9954-1b786857f044",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "390f6727-800b-4a30-a88f-3e1442434892",
"Type": 0,
"ResourceId": "5ae57ca2-d725-447a-82da-455cbb0da61f",
"Units": 3.0
},
{
"Id": "390f6727-800b-4a30-a88f-3e1442434892",
"Type": 0,
"ResourceId": "5ae57ca2-d725-447a-82da-455cbb0da61f",
"Units": 3.0
}
],
"ParentId": "e0f0d75b-8202-4849-a3f1-2116b6e740b5",
"WorkTypeParentId": "f5462183-823b-4801-9446-8fdfec4db3b5",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "d0235141-d2b2-43c2-a3f4-12a8f8f66831",
"UPN": "9ec8d941-4503-408a-86a2-2db45c81f2f1",
"PostDate": "2026-01-07T21:32:31.0799719+00:00",
"Comment": "sample string 4",
"CC": [
"48e35d96-da63-44bd-a16a-84afba9d11b8",
"7b71f5bf-d014-4ad7-9296-bab9c9949948"
],
"Users": [
"12cfb3c6-5bed-4986-b3a7-5a11dbfa18fe",
"369962e8-b1f1-4162-ae77-6ef588ef968d"
]
},
{
"Id": "d0235141-d2b2-43c2-a3f4-12a8f8f66831",
"UPN": "9ec8d941-4503-408a-86a2-2db45c81f2f1",
"PostDate": "2026-01-07T21:32:31.0799719+00:00",
"Comment": "sample string 4",
"CC": [
"48e35d96-da63-44bd-a16a-84afba9d11b8",
"7b71f5bf-d014-4ad7-9296-bab9c9949948"
],
"Users": [
"12cfb3c6-5bed-4986-b3a7-5a11dbfa18fe",
"369962e8-b1f1-4162-ae77-6ef588ef968d"
]
}
],
"StartDate": "2026-01-07T21:32:31.0799719+00:00",
"DueDate": "2026-01-07T21:32:31.0799719+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"18fd840d-535c-48a4-af95-29a97c63efd5": "d755690b-7c21-4db5-a69e-a0106d768219",
"51f6d419-66d9-4672-96f2-544e47e82a76": "eea9141d-3db4-48e5-8280-3b4388c524fb"
},
"HasUpdates": true,
"Modified": "2026-01-07T21:32:31.0799719+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-01-07T21:32:31.0799719+00:00"
},
"LastComment": "2026-01-07T21:32:31.0799719+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "cee52265-82fa-4083-ae4f-6589fce86653",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "de47a264-e688-4cfe-ae1b-dc360b962fd7",
"id": "b15bfa7e-a835-47c0-a10c-d7fa214ee5ee",
"ConfigId": "0848536a-e081-4d4c-8f01-260f7aa8226d"
}