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": "0838f1ec-a4fc-4e03-8b86-82ffc4374076",
"ParentTaskId": "55cd1219-52b2-4b05-a94c-2972b6720273",
"Integration": {
"IntegrationId": "d02ad197-0c51-44d6-9528-aaca173421a7",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c2f48d7d-8aeb-46ac-abeb-fcb1099a0c12": 2.0,
"51448e41-0cdf-4d45-8259-e9270d7e1454": 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": "5df358b3-9f8b-47ee-9b29-aa3c2b3952a9",
"Name": "sample string 1",
"Created": "2026-11-04T19:27:13.1358848+00:00",
"Modified": "2026-11-04T19:27:13.1358848+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"08895997-916d-4d94-a7ff-8c1eaed896ec",
"0b5cc33c-2f88-4674-8c5d-7235eabbeb1d"
],
"NonLaborAssignments": [
{
"Id": "b2c6d3d9-2698-49a8-99f8-bd948b3551f1",
"ResourceId": "14a3e2c2-4525-4312-8145-92d65d27c1f1",
"Quantity": 3.0
},
{
"Id": "b2c6d3d9-2698-49a8-99f8-bd948b3551f1",
"ResourceId": "14a3e2c2-4525-4312-8145-92d65d27c1f1",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "14904bab-32ae-4af9-96df-bc2f0acaf3af",
"Type": 0,
"ResourceId": "8d959795-b3db-497e-8b44-7b7f82ca2fdf",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7aac035a-2ab2-4643-b812-d68ccc7c0d66",
"Start": "2026-11-04T19:27:13.151507+00:00",
"Due": "2026-11-04T19:27:13.151507+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7aac035a-2ab2-4643-b812-d68ccc7c0d66",
"Start": "2026-11-04T19:27:13.151507+00:00",
"Due": "2026-11-04T19:27:13.151507+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "14904bab-32ae-4af9-96df-bc2f0acaf3af",
"Type": 0,
"ResourceId": "8d959795-b3db-497e-8b44-7b7f82ca2fdf",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7aac035a-2ab2-4643-b812-d68ccc7c0d66",
"Start": "2026-11-04T19:27:13.151507+00:00",
"Due": "2026-11-04T19:27:13.151507+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7aac035a-2ab2-4643-b812-d68ccc7c0d66",
"Start": "2026-11-04T19:27:13.151507+00:00",
"Due": "2026-11-04T19:27:13.151507+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "e906e9cb-b230-42d6-af8b-293d0f8269ed",
"WorkTypeParentId": "273830e8-bda5-467d-96ed-ae9050ef81f1",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "2dfb4fa6-2081-4181-9387-bef03eba37dc",
"UPN": "923590a0-c600-4040-bd19-801205aed101",
"PostDate": "2026-11-04T19:27:13.151507+00:00",
"Comment": "sample string 4",
"CC": [
"95966cf7-47cc-4aa4-95ca-b8aa26e220ad",
"ecb59873-1b49-4000-8a8c-6010654bb1f0"
],
"Users": [
"f4e125e0-f852-4eb6-b4e0-74aa705ad7f7",
"6b926805-86a7-4107-88af-dfd7e523da03"
]
},
{
"Id": "2dfb4fa6-2081-4181-9387-bef03eba37dc",
"UPN": "923590a0-c600-4040-bd19-801205aed101",
"PostDate": "2026-11-04T19:27:13.151507+00:00",
"Comment": "sample string 4",
"CC": [
"95966cf7-47cc-4aa4-95ca-b8aa26e220ad",
"ecb59873-1b49-4000-8a8c-6010654bb1f0"
],
"Users": [
"f4e125e0-f852-4eb6-b4e0-74aa705ad7f7",
"6b926805-86a7-4107-88af-dfd7e523da03"
]
}
],
"StartDate": "2026-11-04T19:27:13.151507+00:00",
"DueDate": "2026-11-04T19:27:13.151507+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7c7d746f-4e85-4efe-abc7-5150d4338ba9": "d427007f-abfe-4f3c-b8f5-bcdcbfc5644a",
"91285bf5-1c06-4b5e-97f5-4501aefa91c1": "48752b49-177e-467f-aeff-49584d79ed1d"
},
"HasUpdates": true,
"Modified": "2026-11-04T19:27:13.151507+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-11-04T19:27:13.151507+00:00"
},
"LastComment": "2026-11-04T19:27:13.151507+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d73b5f2d-caad-4fae-82df-e565566559fa",
"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": "cd6aa610-e224-4f1f-b670-33d19af21807",
"id": "c8e7f8f1-8dc1-43f3-97ce-c6e9cd369b14",
"ConfigId": "09e27eaf-ae28-44b3-85be-72bb842981ad"
}