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": "33331b6c-8a9e-4098-a12c-3a8a7a41b9a0",
"ParentTaskId": "d17795dd-6936-4b55-a6a1-345d5234823f",
"Integration": {
"IntegrationId": "111e3075-6c41-44e5-b8e9-5999f1bf4072",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"cd703bf6-1d47-4aef-b02d-c722f04ac0ae": 2.0,
"34896841-4dc1-479b-9f50-b458d62d4b58": 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": "45f91792-b74f-4e7c-9b4d-2f185f5a6b9d",
"Name": "sample string 1",
"Created": "2026-09-23T14:55:39.0100503+00:00",
"Modified": "2026-09-23T14:55:39.0100503+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"31b0e11b-57b0-4f00-84ff-49c040f41897",
"ac812bd4-b8c6-4903-8336-50177160a2a7"
],
"NonLaborAssignments": [
{
"Id": "234f1cce-3a2f-420b-80a9-3e2d4a41cbd1",
"ResourceId": "7483f3f4-f674-486a-849b-6615fdc02e3a",
"Quantity": 3.0
},
{
"Id": "234f1cce-3a2f-420b-80a9-3e2d4a41cbd1",
"ResourceId": "7483f3f4-f674-486a-849b-6615fdc02e3a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "aa74b655-3aca-44fb-bcf4-9848cf019576",
"Type": 0,
"ResourceId": "01ca6033-8716-4173-9c7c-e14cef1a5fbb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "86e09027-7b5c-4bd7-a3f1-8644dafb5846",
"Start": "2026-09-23T14:55:39.0100503+00:00",
"Due": "2026-09-23T14:55:39.0100503+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "86e09027-7b5c-4bd7-a3f1-8644dafb5846",
"Start": "2026-09-23T14:55:39.0100503+00:00",
"Due": "2026-09-23T14:55:39.0100503+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "aa74b655-3aca-44fb-bcf4-9848cf019576",
"Type": 0,
"ResourceId": "01ca6033-8716-4173-9c7c-e14cef1a5fbb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "86e09027-7b5c-4bd7-a3f1-8644dafb5846",
"Start": "2026-09-23T14:55:39.0100503+00:00",
"Due": "2026-09-23T14:55:39.0100503+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "86e09027-7b5c-4bd7-a3f1-8644dafb5846",
"Start": "2026-09-23T14:55:39.0100503+00:00",
"Due": "2026-09-23T14:55:39.0100503+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "79c0c8dc-e6cf-4f8c-8b2c-09f54e421fca",
"WorkTypeParentId": "c1274bc5-cd59-441a-afaf-a5404ba6474b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "beb27466-396f-4c6d-976f-4a443e6bf2ed",
"UPN": "2c9997ca-b9c8-4abb-8bb2-0d17963aea7c",
"PostDate": "2026-09-23T14:55:39.0100503+00:00",
"Comment": "sample string 4",
"CC": [
"b6492cbb-54a4-4a58-b89f-09d97e5d60ae",
"33f01a9e-2221-4d0a-ac1a-1645555148e6"
],
"Users": [
"c764b98a-e8f4-41da-87c2-db2781a05df7",
"c09bdf5f-6b54-4148-8999-4e1833c0daf8"
]
},
{
"Id": "beb27466-396f-4c6d-976f-4a443e6bf2ed",
"UPN": "2c9997ca-b9c8-4abb-8bb2-0d17963aea7c",
"PostDate": "2026-09-23T14:55:39.0100503+00:00",
"Comment": "sample string 4",
"CC": [
"b6492cbb-54a4-4a58-b89f-09d97e5d60ae",
"33f01a9e-2221-4d0a-ac1a-1645555148e6"
],
"Users": [
"c764b98a-e8f4-41da-87c2-db2781a05df7",
"c09bdf5f-6b54-4148-8999-4e1833c0daf8"
]
}
],
"StartDate": "2026-09-23T14:55:39.0100503+00:00",
"DueDate": "2026-09-23T14:55:39.0100503+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4b6a4660-e762-4a74-9244-03a5995b371a": "f92fe8fd-c238-4b43-95bb-0090b187f548",
"21caf4ff-06e0-4b74-a000-c43070717582": "e1c5aca3-0e73-49df-b6f3-448978490acb"
},
"HasUpdates": true,
"Modified": "2026-09-23T14:55:39.0100503+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-23T14:55:39.0256754+00:00"
},
"LastComment": "2026-09-23T14:55:39.0256754+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "96a05dd8-7fc0-478c-8860-b6af2d3da4b1",
"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": "c74b22aa-af1f-4c5f-a866-48955bb65573",
"id": "9b1d0288-fc63-4347-a47a-483c3e8d52c0",
"ConfigId": "0dceb651-a281-42e0-8eeb-3a17703fe0e0"
}