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": "04ba1f57-0402-4349-8a7f-075da2fc15a2",
"ParentTaskId": "09756b5d-37db-4670-8e11-042e7621ea22",
"Integration": {
"IntegrationId": "c9818643-c6a9-4dd8-a613-298bcff8f102",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f2b2b796-8e48-458c-86ba-c945d62f6389": 2.0,
"f9f94c55-1d97-4301-8111-f8a0ad241a6f": 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": "ba391413-ee74-4cd0-82eb-c29c9c33e249",
"Name": "sample string 1",
"Created": "2026-10-20T00:02:12.7353551+00:00",
"Modified": "2026-10-20T00:02:12.7353551+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"744913c9-eeb7-4025-861c-20e3ff24069d",
"aa79fc2c-bd21-4809-ac4b-66d4d822bbeb"
],
"NonLaborAssignments": [
{
"Id": "6b1d8990-b951-4e3a-a4f8-9cf56111f88d",
"ResourceId": "e5e3ec1f-6304-4743-9d9e-2ad40bae3268",
"Quantity": 3.0
},
{
"Id": "6b1d8990-b951-4e3a-a4f8-9cf56111f88d",
"ResourceId": "e5e3ec1f-6304-4743-9d9e-2ad40bae3268",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3978c3ad-9d0e-46a9-9e72-d374b58f606f",
"Type": 0,
"ResourceId": "715ffd08-1d9b-4e9d-846d-f7a76c5bfc1e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "05a4ac78-b374-440b-b624-e57021fb605d",
"Start": "2026-10-20T00:02:12.7353551+00:00",
"Due": "2026-10-20T00:02:12.7353551+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "05a4ac78-b374-440b-b624-e57021fb605d",
"Start": "2026-10-20T00:02:12.7353551+00:00",
"Due": "2026-10-20T00:02:12.7353551+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "3978c3ad-9d0e-46a9-9e72-d374b58f606f",
"Type": 0,
"ResourceId": "715ffd08-1d9b-4e9d-846d-f7a76c5bfc1e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "05a4ac78-b374-440b-b624-e57021fb605d",
"Start": "2026-10-20T00:02:12.7353551+00:00",
"Due": "2026-10-20T00:02:12.7353551+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "05a4ac78-b374-440b-b624-e57021fb605d",
"Start": "2026-10-20T00:02:12.7353551+00:00",
"Due": "2026-10-20T00:02:12.7353551+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "a7c024d3-bb3f-43be-99d4-3c01556e457a",
"WorkTypeParentId": "cf40723b-d703-4393-ab59-0ba669feda29",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f530a537-56e2-40f0-b152-a1fa1b927ccd",
"UPN": "54d7ebbf-c01d-4145-814f-a1115453e5c9",
"PostDate": "2026-10-20T00:02:12.7353551+00:00",
"Comment": "sample string 4",
"CC": [
"b71e2565-3674-4cb7-904b-52b5fe0ae55a",
"fb1beafb-69a0-44a9-a107-1677d6059ab1"
],
"Users": [
"10b6c39e-05c6-4d6c-b86d-6bab9f7ea333",
"4df59fd7-9b11-487b-9ac2-f5ade474f8e3"
]
},
{
"Id": "f530a537-56e2-40f0-b152-a1fa1b927ccd",
"UPN": "54d7ebbf-c01d-4145-814f-a1115453e5c9",
"PostDate": "2026-10-20T00:02:12.7353551+00:00",
"Comment": "sample string 4",
"CC": [
"b71e2565-3674-4cb7-904b-52b5fe0ae55a",
"fb1beafb-69a0-44a9-a107-1677d6059ab1"
],
"Users": [
"10b6c39e-05c6-4d6c-b86d-6bab9f7ea333",
"4df59fd7-9b11-487b-9ac2-f5ade474f8e3"
]
}
],
"StartDate": "2026-10-20T00:02:12.7353551+00:00",
"DueDate": "2026-10-20T00:02:12.7353551+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"6cb4bc48-f82c-48fe-b50a-7fcbb982dd3f": "77bb9a98-42c7-4a42-8749-f78fa1e54022",
"4fbf4df0-ee35-463e-94ee-1744de538968": "195fefbb-df6e-48d9-a16d-1724fa8730ec"
},
"HasUpdates": true,
"Modified": "2026-10-20T00:02:12.7353551+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-20T00:02:12.7353551+00:00"
},
"LastComment": "2026-10-20T00:02:12.7353551+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c4666adf-0f80-42f6-bc12-574ba9e5db8f",
"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": "5f5f2ce1-49ef-49ea-ba7f-5a6c3460e2db",
"id": "9bb07cef-6b6c-48fd-89da-f1a958e2c499",
"ConfigId": "d21951e4-6d4f-438c-9dae-589a51ed2b4a"
}