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": "91a568a6-a553-4d7b-a76e-9a2aed7211b2",
"ParentTaskId": "7ed90f38-9699-451e-acb1-9da4040a48d6",
"Integration": {
"IntegrationId": "2cf2f7d2-5c7b-4643-95d6-c96e03f0687b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b1b93c0b-fc2b-418a-a076-c1460063b8ab": 2.0,
"de6718a1-6ffe-4227-9a65-74c7d2f318b7": 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": "8076c27c-7b2d-41e0-842d-129813d3e42a",
"Name": "sample string 1",
"Created": "2026-10-11T07:33:52.3952837+00:00",
"Modified": "2026-10-11T07:33:52.3952837+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"af501579-d6bf-49f0-b625-12091635d7f1",
"ae5ac201-69c1-44e0-b46d-4b256da3b604"
],
"NonLaborAssignments": [
{
"Id": "2c8a0b28-9491-43b5-a03d-1d6b7a325c76",
"ResourceId": "025e31fe-24e5-4b8d-9d0c-c23a7ca8a3de",
"Quantity": 3.0
},
{
"Id": "2c8a0b28-9491-43b5-a03d-1d6b7a325c76",
"ResourceId": "025e31fe-24e5-4b8d-9d0c-c23a7ca8a3de",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1f29b93f-b3b7-4e80-9b2a-738ec9edc334",
"Type": 0,
"ResourceId": "fa449819-0d7a-47a3-8695-a99aa4c4c4b2",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "645a332a-a2a1-4e6c-b22b-28c4fdc473a4",
"Start": "2026-10-11T07:33:52.3952837+00:00",
"Due": "2026-10-11T07:33:52.3952837+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "645a332a-a2a1-4e6c-b22b-28c4fdc473a4",
"Start": "2026-10-11T07:33:52.3952837+00:00",
"Due": "2026-10-11T07:33:52.3952837+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "1f29b93f-b3b7-4e80-9b2a-738ec9edc334",
"Type": 0,
"ResourceId": "fa449819-0d7a-47a3-8695-a99aa4c4c4b2",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "645a332a-a2a1-4e6c-b22b-28c4fdc473a4",
"Start": "2026-10-11T07:33:52.3952837+00:00",
"Due": "2026-10-11T07:33:52.3952837+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "645a332a-a2a1-4e6c-b22b-28c4fdc473a4",
"Start": "2026-10-11T07:33:52.3952837+00:00",
"Due": "2026-10-11T07:33:52.3952837+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "08fa0785-c803-4e0b-8c28-7a0316ad91f4",
"WorkTypeParentId": "7df0a61e-e86a-4955-9dbb-a6ebc378ec84",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c0b40959-f969-4f5b-8a5c-b3a675338354",
"UPN": "2ac213dd-352f-425d-b5da-213c7b0f158b",
"PostDate": "2026-10-11T07:33:52.3952837+00:00",
"Comment": "sample string 4",
"CC": [
"7dd9cdeb-34fe-47b2-98ef-1411b857c20c",
"c7852415-50e3-4559-8ec2-0fb31f90808c"
],
"Users": [
"5be48d59-6f14-4179-a325-a8489dc8ac5e",
"c3deebc3-8206-4837-8205-9c3ed9849b0d"
]
},
{
"Id": "c0b40959-f969-4f5b-8a5c-b3a675338354",
"UPN": "2ac213dd-352f-425d-b5da-213c7b0f158b",
"PostDate": "2026-10-11T07:33:52.3952837+00:00",
"Comment": "sample string 4",
"CC": [
"7dd9cdeb-34fe-47b2-98ef-1411b857c20c",
"c7852415-50e3-4559-8ec2-0fb31f90808c"
],
"Users": [
"5be48d59-6f14-4179-a325-a8489dc8ac5e",
"c3deebc3-8206-4837-8205-9c3ed9849b0d"
]
}
],
"StartDate": "2026-10-11T07:33:52.3952837+00:00",
"DueDate": "2026-10-11T07:33:52.3952837+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4aa0a2c1-bc01-4d6c-9beb-a6d8afb209af": "4291d317-5ac4-4fdc-b517-91cd349b4e17",
"d0e50e16-19a3-44db-95a0-e305d9ec2c46": "12f6b75d-5c1f-4c43-8dd2-40c47ac29da3"
},
"HasUpdates": true,
"Modified": "2026-10-11T07:33:52.3952837+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-11T07:33:52.3952837+00:00"
},
"LastComment": "2026-10-11T07:33:52.3952837+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0b3c91ff-de0b-40bc-8da8-5a752819e934",
"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": "e0b469fd-737f-439b-abf4-958896f1e7a5",
"id": "37d925a6-2908-4bee-8573-db16f51b8320",
"ConfigId": "7fb3fcf6-edb2-4f54-9b58-e14868b7f31d"
}