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": "60f9aa26-355c-48b6-81af-8f7efc940d23",
"ParentTaskId": "6f34ac35-72b6-498d-9afc-d280c5d091eb",
"Integration": {
"IntegrationId": "353dbe2d-d762-4f73-a2cc-319a574accc2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"da41a224-16f6-4d76-bf63-8281e65a2c5f": 2.0,
"efaa0e7a-b8fa-4c68-9ee6-392e9c4934ce": 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": "d3598be2-45cb-4818-a863-8603c187db89",
"Name": "sample string 1",
"Created": "2026-09-15T06:36:40.0540603+00:00",
"Modified": "2026-09-15T06:36:40.0540603+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1b1ed142-6e46-42cd-93bf-d362310f0388",
"76b04dff-8c71-475a-a00c-895822664871"
],
"NonLaborAssignments": [
{
"Id": "ff428c58-3786-4ec6-ac0f-c85dedfc2b89",
"ResourceId": "c4b834ad-44ac-422a-9bc3-3d8cc7a687a0",
"Quantity": 3.0
},
{
"Id": "ff428c58-3786-4ec6-ac0f-c85dedfc2b89",
"ResourceId": "c4b834ad-44ac-422a-9bc3-3d8cc7a687a0",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b267a59d-08b3-4b70-b034-471da6f557aa",
"Type": 0,
"ResourceId": "da9b637d-06db-4aa7-89ce-050aec8eb367",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "04622014-bad1-4ea3-afc8-8ddca55691b4",
"Start": "2026-09-15T06:36:40.0696819+00:00",
"Due": "2026-09-15T06:36:40.0696819+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "04622014-bad1-4ea3-afc8-8ddca55691b4",
"Start": "2026-09-15T06:36:40.0696819+00:00",
"Due": "2026-09-15T06:36:40.0696819+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "b267a59d-08b3-4b70-b034-471da6f557aa",
"Type": 0,
"ResourceId": "da9b637d-06db-4aa7-89ce-050aec8eb367",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "04622014-bad1-4ea3-afc8-8ddca55691b4",
"Start": "2026-09-15T06:36:40.0696819+00:00",
"Due": "2026-09-15T06:36:40.0696819+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "04622014-bad1-4ea3-afc8-8ddca55691b4",
"Start": "2026-09-15T06:36:40.0696819+00:00",
"Due": "2026-09-15T06:36:40.0696819+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "c688e5eb-f847-41ac-9259-ae66d2fc90b3",
"WorkTypeParentId": "794aff60-8d40-4fe1-9bd3-be76cb439f2d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "670f1625-78e8-443f-905d-23f49b8f12d2",
"UPN": "ead9da08-dd2d-4bc1-b92f-af102c878c61",
"PostDate": "2026-09-15T06:36:40.0696819+00:00",
"Comment": "sample string 4",
"CC": [
"042c5e64-14e6-48ff-89d6-be50b5ca70c8",
"a0554e3b-6d18-4c94-ac68-c132190dce83"
],
"Users": [
"7b8efbf4-c7cd-4420-abd3-507cad8680f2",
"f7145511-b30f-4817-a0a0-b44263c79e41"
]
},
{
"Id": "670f1625-78e8-443f-905d-23f49b8f12d2",
"UPN": "ead9da08-dd2d-4bc1-b92f-af102c878c61",
"PostDate": "2026-09-15T06:36:40.0696819+00:00",
"Comment": "sample string 4",
"CC": [
"042c5e64-14e6-48ff-89d6-be50b5ca70c8",
"a0554e3b-6d18-4c94-ac68-c132190dce83"
],
"Users": [
"7b8efbf4-c7cd-4420-abd3-507cad8680f2",
"f7145511-b30f-4817-a0a0-b44263c79e41"
]
}
],
"StartDate": "2026-09-15T06:36:40.0696819+00:00",
"DueDate": "2026-09-15T06:36:40.0696819+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7e3ed9b9-9f52-4470-8ae6-ee25c6060d63": "16babec1-1ea5-4dcf-bf89-1747dd5a0581",
"48d87ac8-86da-484b-92b0-014b65504137": "415fddb3-76fe-43d2-8d3d-ef3c830fecef"
},
"HasUpdates": true,
"Modified": "2026-09-15T06:36:40.0696819+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-15T06:36:40.0696819+00:00"
},
"LastComment": "2026-09-15T06:36:40.0696819+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d82a1ca1-9bcf-4746-b641-8bbd9ad5b0c6",
"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": "afe102bc-d5f7-4323-b800-d1d12de49f2f",
"id": "95c97a48-845c-4f5c-8497-27ae3dce7f32",
"ConfigId": "315a361f-767b-4de6-8d8a-5a4a1e9fd6fd"
}