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": "43466984-a38c-4cd0-b516-3646eee38d3c",
"ParentTaskId": "68b6eaa7-574f-4026-a8fd-78915a364874",
"Integration": {
"IntegrationId": "d8f963b9-82ca-47e4-a450-453f12baa8f2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"ea516b46-f362-4a5d-8fd1-24db423e14ce": 2.0,
"223d7730-32ad-4b4b-955c-cd2d1bb09914": 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": "26d6031e-056a-4cf6-a031-9f4a4e1040f6",
"Name": "sample string 1",
"Created": "2026-09-11T20:32:36.2685312+00:00",
"Modified": "2026-09-11T20:32:36.2685312+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"08a280b8-0aef-4316-aa6f-b6d0ccc32ca7",
"6c4701ad-a708-46c8-9312-f89aa6ad2170"
],
"NonLaborAssignments": [
{
"Id": "428b69d3-9203-4376-8c40-2b5f9b437088",
"ResourceId": "622dad9c-bd01-4588-a049-f62bf0d487a6",
"Quantity": 3.0
},
{
"Id": "428b69d3-9203-4376-8c40-2b5f9b437088",
"ResourceId": "622dad9c-bd01-4588-a049-f62bf0d487a6",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7d837f39-65a3-4208-9772-1f69f058d3cc",
"Type": 0,
"ResourceId": "0d7a004b-e5ae-44b5-88ce-72c41404a8ea",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "a3d86531-342a-4be4-adc7-213fae836a9b",
"Start": "2026-09-11T20:32:36.2685312+00:00",
"Due": "2026-09-11T20:32:36.2685312+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "a3d86531-342a-4be4-adc7-213fae836a9b",
"Start": "2026-09-11T20:32:36.2685312+00:00",
"Due": "2026-09-11T20:32:36.2685312+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "7d837f39-65a3-4208-9772-1f69f058d3cc",
"Type": 0,
"ResourceId": "0d7a004b-e5ae-44b5-88ce-72c41404a8ea",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "a3d86531-342a-4be4-adc7-213fae836a9b",
"Start": "2026-09-11T20:32:36.2685312+00:00",
"Due": "2026-09-11T20:32:36.2685312+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "a3d86531-342a-4be4-adc7-213fae836a9b",
"Start": "2026-09-11T20:32:36.2685312+00:00",
"Due": "2026-09-11T20:32:36.2685312+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "69702717-a786-4ec3-9b8c-954a4ba1da8c",
"WorkTypeParentId": "778d1f1c-0b9d-4f94-808d-12173f87dd47",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "21fdd5fe-e9b4-4584-8783-a94cf3dbe3e3",
"UPN": "18b31422-916d-468e-9102-7eb013a37f66",
"PostDate": "2026-09-11T20:32:36.2685312+00:00",
"Comment": "sample string 4",
"CC": [
"ef319847-84f1-442e-8af6-30eea08659be",
"95709997-ee99-4db0-b0cc-a9b19e3c2239"
],
"Users": [
"790c5252-6017-48a6-9f80-f263f1a46e72",
"827a4121-97ee-4263-b4c2-8a75009954b0"
]
},
{
"Id": "21fdd5fe-e9b4-4584-8783-a94cf3dbe3e3",
"UPN": "18b31422-916d-468e-9102-7eb013a37f66",
"PostDate": "2026-09-11T20:32:36.2685312+00:00",
"Comment": "sample string 4",
"CC": [
"ef319847-84f1-442e-8af6-30eea08659be",
"95709997-ee99-4db0-b0cc-a9b19e3c2239"
],
"Users": [
"790c5252-6017-48a6-9f80-f263f1a46e72",
"827a4121-97ee-4263-b4c2-8a75009954b0"
]
}
],
"StartDate": "2026-09-11T20:32:36.2685312+00:00",
"DueDate": "2026-09-11T20:32:36.2685312+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9e36ef1b-0788-4c5b-8f12-c914ef483bbb": "0df3332e-04bd-4f63-9264-9649154e41ed",
"6ccc31f7-e149-4ed3-9b81-7e4a2f0ef79e": "63d4cc5f-1c41-4ba3-b08f-097826fe8aac"
},
"HasUpdates": true,
"Modified": "2026-09-11T20:32:36.2685312+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-11T20:32:36.2685312+00:00"
},
"LastComment": "2026-09-11T20:32:36.2685312+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2c148a0d-7e52-48b9-b58a-13f539b5926b",
"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": "7bd30e2b-8550-46db-b906-485a17d21c44",
"id": "e8203e7f-c37d-474c-8d21-03e3d8901614",
"ConfigId": "1b1838fa-8c3a-41c4-a209-0b949f4ffa80"
}