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": "3ce50895-2775-46cf-97c1-4dd6df1090f9",
"ParentTaskId": "419967c8-7223-4978-81dd-b2794ed8741f",
"Integration": {
"IntegrationId": "acbce38e-8ecd-4092-a815-c5b6415fe334",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e21c9c02-0743-4618-8c5a-5f6fbdc9d1d0": 2.0,
"35bde911-8c95-49f3-bb04-c7135d42a6ec": 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": "b72924ab-8191-4dea-ae0e-089e4c557204",
"Name": "sample string 1",
"Created": "2026-09-10T16:53:03.8459265+00:00",
"Modified": "2026-09-10T16:53:03.8459265+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e8eaae82-3654-4b50-8c41-c264c3e28c82",
"930f044e-0415-430f-98ad-b4ef01945e6f"
],
"NonLaborAssignments": [
{
"Id": "004fb939-14f9-450e-9ca2-2545ece12df3",
"ResourceId": "9ca8197a-8b69-4b29-b18d-aa6f176c5b5c",
"Quantity": 3.0
},
{
"Id": "004fb939-14f9-450e-9ca2-2545ece12df3",
"ResourceId": "9ca8197a-8b69-4b29-b18d-aa6f176c5b5c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "04fcc9cc-e8f9-4e3d-ba7b-390238d8037f",
"Type": 0,
"ResourceId": "e2314c82-ddc1-48aa-aacb-5810730009fc",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6817d6ea-f306-4630-af90-d589373a1f12",
"Start": "2026-09-10T16:53:03.8459265+00:00",
"Due": "2026-09-10T16:53:03.8459265+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6817d6ea-f306-4630-af90-d589373a1f12",
"Start": "2026-09-10T16:53:03.8459265+00:00",
"Due": "2026-09-10T16:53:03.8459265+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "04fcc9cc-e8f9-4e3d-ba7b-390238d8037f",
"Type": 0,
"ResourceId": "e2314c82-ddc1-48aa-aacb-5810730009fc",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6817d6ea-f306-4630-af90-d589373a1f12",
"Start": "2026-09-10T16:53:03.8459265+00:00",
"Due": "2026-09-10T16:53:03.8459265+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6817d6ea-f306-4630-af90-d589373a1f12",
"Start": "2026-09-10T16:53:03.8459265+00:00",
"Due": "2026-09-10T16:53:03.8459265+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "42609289-c39b-4e90-950a-d772e26d4be3",
"WorkTypeParentId": "4c222584-43b7-4668-9d00-6ec345b0c4ca",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b8d65b7f-959d-4f19-96f9-fd10a095ad30",
"UPN": "39a52a13-c9a7-4fdd-8eaa-a1a48668d091",
"PostDate": "2026-09-10T16:53:03.8459265+00:00",
"Comment": "sample string 4",
"CC": [
"560d5228-f481-4367-b6bb-6bdb6f43f5f3",
"fbf232a1-5ffd-4d81-979d-0567492ae839"
],
"Users": [
"16436861-70d8-42d6-9239-b3c5643a911d",
"06deb4f6-c79f-4538-9318-88eb363114b1"
]
},
{
"Id": "b8d65b7f-959d-4f19-96f9-fd10a095ad30",
"UPN": "39a52a13-c9a7-4fdd-8eaa-a1a48668d091",
"PostDate": "2026-09-10T16:53:03.8459265+00:00",
"Comment": "sample string 4",
"CC": [
"560d5228-f481-4367-b6bb-6bdb6f43f5f3",
"fbf232a1-5ffd-4d81-979d-0567492ae839"
],
"Users": [
"16436861-70d8-42d6-9239-b3c5643a911d",
"06deb4f6-c79f-4538-9318-88eb363114b1"
]
}
],
"StartDate": "2026-09-10T16:53:03.8459265+00:00",
"DueDate": "2026-09-10T16:53:03.8459265+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"db7ea1cc-2cce-4b3e-b860-4b47211d5f02": "c6d3f7d3-ecad-42a3-abac-8e9ecb426970",
"7ca4120b-0c55-4751-8749-c1debc4d86e6": "bf62d502-35dd-46c1-b44f-0c11655bacc2"
},
"HasUpdates": true,
"Modified": "2026-09-10T16:53:03.8459265+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-10T16:53:03.8459265+00:00"
},
"LastComment": "2026-09-10T16:53:03.8459265+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9f73c7e4-86dd-4ed6-ae23-688d911140f6",
"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": "1dd085b3-199c-4c17-afae-a4908ed38465",
"id": "4b4dfde0-02f2-4ae0-a042-a2bf5026a7b4",
"ConfigId": "333467a1-7919-4165-989f-34297e1c18d4"
}