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": "6f32187e-34b1-472c-ac9e-c5242e276b08",
"ParentTaskId": "d0eddc85-7552-43e3-93c1-dac5862bda74",
"Integration": {
"IntegrationId": "dd52dd2e-07bb-4bda-ad37-dfd6139fd122",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"93ef7e7b-2a97-4336-90e9-a9805d88a04b": 2.0,
"c05f101b-7866-41ed-ab22-de31a0ccd3cd": 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": "b048cd53-558c-416f-863c-416e3ef5a66c",
"Name": "sample string 1",
"Created": "2026-09-01T07:24:35.2195022+00:00",
"Modified": "2026-09-01T07:24:35.2195022+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e8f41f4b-6f2d-499d-aca9-e2797a5e9235",
"db818efd-0b9e-4ac9-ae5a-aba1006ba62b"
],
"NonLaborAssignments": [
{
"Id": "ed7d137a-f4b0-4afb-9da5-2f791ff94753",
"ResourceId": "4fb924b3-fd86-4250-b7db-ddc766dabaa5",
"Quantity": 3.0
},
{
"Id": "ed7d137a-f4b0-4afb-9da5-2f791ff94753",
"ResourceId": "4fb924b3-fd86-4250-b7db-ddc766dabaa5",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "30087afe-e8d8-40c0-aebe-68c58bef7288",
"Type": 0,
"ResourceId": "11598a0c-a079-479e-b1e0-0b0cdf2a6a6e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9fa1ba3c-5ec2-4a08-94fa-d2d83349cb2b",
"Start": "2026-09-01T07:24:35.2195022+00:00",
"Due": "2026-09-01T07:24:35.2195022+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9fa1ba3c-5ec2-4a08-94fa-d2d83349cb2b",
"Start": "2026-09-01T07:24:35.2195022+00:00",
"Due": "2026-09-01T07:24:35.2195022+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "30087afe-e8d8-40c0-aebe-68c58bef7288",
"Type": 0,
"ResourceId": "11598a0c-a079-479e-b1e0-0b0cdf2a6a6e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9fa1ba3c-5ec2-4a08-94fa-d2d83349cb2b",
"Start": "2026-09-01T07:24:35.2195022+00:00",
"Due": "2026-09-01T07:24:35.2195022+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9fa1ba3c-5ec2-4a08-94fa-d2d83349cb2b",
"Start": "2026-09-01T07:24:35.2195022+00:00",
"Due": "2026-09-01T07:24:35.2195022+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "c4f10aa3-a149-4ae6-80f7-c94c312598b3",
"WorkTypeParentId": "53d8fa52-cb35-4caf-a88e-642b8ad619fd",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "cd440829-77cd-43d3-9c4e-4c0c6d9ecf39",
"UPN": "c033b74a-663e-4b9b-b347-90bc22d0e4c8",
"PostDate": "2026-09-01T07:24:35.2195022+00:00",
"Comment": "sample string 4",
"CC": [
"6ef77af3-a7d5-4584-a930-9cb686de7aae",
"2da869b3-d235-41e5-ad22-cb5f56fc3a72"
],
"Users": [
"e027d969-e1e4-4efa-ae26-e34f081f4235",
"106bbfc9-e7a6-4a8e-b586-4c36a94e2fb2"
]
},
{
"Id": "cd440829-77cd-43d3-9c4e-4c0c6d9ecf39",
"UPN": "c033b74a-663e-4b9b-b347-90bc22d0e4c8",
"PostDate": "2026-09-01T07:24:35.2195022+00:00",
"Comment": "sample string 4",
"CC": [
"6ef77af3-a7d5-4584-a930-9cb686de7aae",
"2da869b3-d235-41e5-ad22-cb5f56fc3a72"
],
"Users": [
"e027d969-e1e4-4efa-ae26-e34f081f4235",
"106bbfc9-e7a6-4a8e-b586-4c36a94e2fb2"
]
}
],
"StartDate": "2026-09-01T07:24:35.2195022+00:00",
"DueDate": "2026-09-01T07:24:35.2195022+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d5bcd4cc-7e32-4040-92a9-86e4873e553e": "d3a5c9b7-3e7d-41e3-8c2b-841a51911dd0",
"798c1771-f2de-433f-9ad5-86825a165037": "7dc98dd8-a7ab-4213-932c-9d6eaa6189ed"
},
"HasUpdates": true,
"Modified": "2026-09-01T07:24:35.2195022+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-01T07:24:35.2195022+00:00"
},
"LastComment": "2026-09-01T07:24:35.2195022+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c1171796-1967-40f6-9b7f-5521af202610",
"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": "173c3b0c-fe14-4500-9359-61190902771b",
"id": "38b6dd46-1d2b-49e9-8828-4730e3329faf",
"ConfigId": "3b727ec2-95f0-40fb-a4da-f2ac2f14480e"
}