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": "49fc284c-8de2-4b1b-ab82-20c3a74711c2",
"ParentTaskId": "012129a1-6a91-4f87-a119-a65b48a8c9b6",
"Integration": {
"IntegrationId": "96ef42e7-a410-48b6-977b-89841a095d63",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"476c0ae1-b34f-411a-886c-77c94ebbd67a": 2.0,
"0307fa8a-1e80-4e02-bc3d-070d0cc8ea2c": 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": "68c1e335-97a4-43cd-b479-1a69ba157459",
"Name": "sample string 1",
"Created": "2026-09-17T01:29:11.5820699+00:00",
"Modified": "2026-09-17T01:29:11.5820699+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f6f3e599-5e17-4eae-a9c9-e967ad2fb74f",
"cd30f795-1a14-4a82-ba91-0c5486834b7b"
],
"NonLaborAssignments": [
{
"Id": "fade50cc-a9f7-475d-8ae2-60141304d169",
"ResourceId": "2db88797-341f-4062-9e73-e49999e5a9f7",
"Quantity": 3.0
},
{
"Id": "fade50cc-a9f7-475d-8ae2-60141304d169",
"ResourceId": "2db88797-341f-4062-9e73-e49999e5a9f7",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3d6825f5-9907-4b23-9825-d6d14945f49c",
"Type": 0,
"ResourceId": "05fd4404-4a3a-45c6-b0c4-32ebd3ee250f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "f40062d5-011d-4f4f-aecb-f82976335289",
"Start": "2026-09-17T01:29:11.5820699+00:00",
"Due": "2026-09-17T01:29:11.5820699+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "f40062d5-011d-4f4f-aecb-f82976335289",
"Start": "2026-09-17T01:29:11.5820699+00:00",
"Due": "2026-09-17T01:29:11.5820699+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "3d6825f5-9907-4b23-9825-d6d14945f49c",
"Type": 0,
"ResourceId": "05fd4404-4a3a-45c6-b0c4-32ebd3ee250f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "f40062d5-011d-4f4f-aecb-f82976335289",
"Start": "2026-09-17T01:29:11.5820699+00:00",
"Due": "2026-09-17T01:29:11.5820699+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "f40062d5-011d-4f4f-aecb-f82976335289",
"Start": "2026-09-17T01:29:11.5820699+00:00",
"Due": "2026-09-17T01:29:11.5820699+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "53a57a2b-c736-4d96-939f-9bc2e3c76506",
"WorkTypeParentId": "2045377f-f7b4-4dc7-8f2b-c856c444d853",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b75ee9e3-83f8-4a21-be49-133adde21c5b",
"UPN": "432a3fdd-0f84-46f1-94df-de6ee84c645c",
"PostDate": "2026-09-17T01:29:11.5820699+00:00",
"Comment": "sample string 4",
"CC": [
"0f253987-17db-4715-9c96-603729ca7795",
"3a65db44-dadb-4687-ba07-9d3dd1844cb3"
],
"Users": [
"fd5c3376-ab2b-420c-aa47-a865f22ddc0d",
"c66bd2ae-9240-44d0-ac26-da0612e4cd09"
]
},
{
"Id": "b75ee9e3-83f8-4a21-be49-133adde21c5b",
"UPN": "432a3fdd-0f84-46f1-94df-de6ee84c645c",
"PostDate": "2026-09-17T01:29:11.5820699+00:00",
"Comment": "sample string 4",
"CC": [
"0f253987-17db-4715-9c96-603729ca7795",
"3a65db44-dadb-4687-ba07-9d3dd1844cb3"
],
"Users": [
"fd5c3376-ab2b-420c-aa47-a865f22ddc0d",
"c66bd2ae-9240-44d0-ac26-da0612e4cd09"
]
}
],
"StartDate": "2026-09-17T01:29:11.5820699+00:00",
"DueDate": "2026-09-17T01:29:11.5820699+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4d45c418-1a34-4c8f-aac8-09ada9cb6e08": "72b32e54-0eb2-48c9-8828-12304144a5f1",
"fd979208-1a0f-4718-a453-ac9d49c638f9": "22314921-345f-45f1-b690-6d75a3696a9f"
},
"HasUpdates": true,
"Modified": "2026-09-17T01:29:11.5820699+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-17T01:29:11.5820699+00:00"
},
"LastComment": "2026-09-17T01:29:11.5820699+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "64cc02a4-b731-43e2-a5ae-d8693e81c125",
"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": "a5e97a47-f847-462b-a914-e2d37b042387",
"id": "6b928259-672a-4fe8-b6fd-1df40779d9a4",
"ConfigId": "08479298-12ac-4a75-a743-1ed5945626aa"
}