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": "c6f1a584-2c5c-4750-935d-276321a2d62e",
"ParentTaskId": "f6204005-0b8e-429e-9e3c-f84ebafe2cc2",
"Integration": {
"IntegrationId": "3f69b1a3-cbae-4364-a01e-ea5359bc33c2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2dd7ae56-3b4a-4bc9-89c4-60b768d59a2f": 2.0,
"926ab407-ffac-4782-8084-7e0000fb1c0e": 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": "4c9651cd-2c9f-4df5-85fb-ce396bdaf63c",
"Name": "sample string 1",
"Created": "2026-10-16T18:01:46.2307122+00:00",
"Modified": "2026-10-16T18:01:46.2307122+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3a87cfbc-fe20-4e4b-a235-27b0bb4dfbd1",
"7dd2cbec-dfca-4fa0-85d9-74fe0c911cb6"
],
"NonLaborAssignments": [
{
"Id": "fd80d9d3-6098-424a-be36-c6729553858a",
"ResourceId": "5df6b640-1aca-459d-89ba-055e3f646d5e",
"Quantity": 3.0
},
{
"Id": "fd80d9d3-6098-424a-be36-c6729553858a",
"ResourceId": "5df6b640-1aca-459d-89ba-055e3f646d5e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "57962efe-4ca6-46de-8123-5aa20dccb864",
"Type": 0,
"ResourceId": "c21b27be-bf76-42af-b715-3c5e0b8fe019",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "51e0bef8-6ed0-4530-bcfd-d51bca4c9b8c",
"Start": "2026-10-16T18:01:46.2307122+00:00",
"Due": "2026-10-16T18:01:46.2307122+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "51e0bef8-6ed0-4530-bcfd-d51bca4c9b8c",
"Start": "2026-10-16T18:01:46.2307122+00:00",
"Due": "2026-10-16T18:01:46.2307122+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "57962efe-4ca6-46de-8123-5aa20dccb864",
"Type": 0,
"ResourceId": "c21b27be-bf76-42af-b715-3c5e0b8fe019",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "51e0bef8-6ed0-4530-bcfd-d51bca4c9b8c",
"Start": "2026-10-16T18:01:46.2307122+00:00",
"Due": "2026-10-16T18:01:46.2307122+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "51e0bef8-6ed0-4530-bcfd-d51bca4c9b8c",
"Start": "2026-10-16T18:01:46.2307122+00:00",
"Due": "2026-10-16T18:01:46.2307122+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "e9ac74a4-2ed5-4eea-8644-9c51a965f251",
"WorkTypeParentId": "8df78463-7950-43d3-a200-e6be3def2cbe",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "d7a67da4-7ef5-4c3c-8ac7-e2a73178bc03",
"UPN": "5a3cc91b-4a88-4856-8d3b-b0c64ff9b238",
"PostDate": "2026-10-16T18:01:46.2307122+00:00",
"Comment": "sample string 4",
"CC": [
"043c23ab-02e0-4da7-b59c-8b46c3c373ae",
"c0426e9d-f3a1-4297-a50a-d74165bf32b6"
],
"Users": [
"ceb9b472-cc88-4fe2-a310-ccce0f24f3b8",
"2425e9c4-310f-426d-bd39-450f5dda196e"
]
},
{
"Id": "d7a67da4-7ef5-4c3c-8ac7-e2a73178bc03",
"UPN": "5a3cc91b-4a88-4856-8d3b-b0c64ff9b238",
"PostDate": "2026-10-16T18:01:46.2307122+00:00",
"Comment": "sample string 4",
"CC": [
"043c23ab-02e0-4da7-b59c-8b46c3c373ae",
"c0426e9d-f3a1-4297-a50a-d74165bf32b6"
],
"Users": [
"ceb9b472-cc88-4fe2-a310-ccce0f24f3b8",
"2425e9c4-310f-426d-bd39-450f5dda196e"
]
}
],
"StartDate": "2026-10-16T18:01:46.2307122+00:00",
"DueDate": "2026-10-16T18:01:46.2307122+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bc48511b-1a95-445f-9c7c-09f50e8cb34b": "5123e590-1d48-41e6-9339-4163419a1850",
"8218ea40-fe21-4143-833c-2f7a0ab20431": "1f69a957-c8f5-449d-a9b9-d5c7166e45c3"
},
"HasUpdates": true,
"Modified": "2026-10-16T18:01:46.2307122+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-16T18:01:46.2307122+00:00"
},
"LastComment": "2026-10-16T18:01:46.2307122+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0cc85f76-13fa-4a4c-8644-c880772881c9",
"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": "6f0a7864-3a45-48cf-86bf-6705bb253436",
"id": "b9676682-fe8d-4a17-ba63-c2367f45f244",
"ConfigId": "3ad1a0ae-d4e1-4cb0-a376-b47555d6caab"
}