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": "6a672a7b-5ec3-49b9-9c86-e8bb0b4502ae",
"ParentTaskId": "fc754fdd-41e2-4433-b74e-b8baaae13d67",
"Integration": {
"IntegrationId": "4634b35d-a59c-4713-9e98-9f14471461ab",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"3f03d6b0-cc85-4e99-8868-cc079fdbcdb4": 2.0,
"52e4780f-9549-4b02-87ee-b6aa3a25762f": 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": "e80d5fc8-fd56-43bb-9a5c-15903d07ca9b",
"Name": "sample string 1",
"Created": "2026-10-09T16:06:19.5263297+00:00",
"Modified": "2026-10-09T16:06:19.5263297+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"66c91146-efbc-436e-9b00-0726d5253d6e",
"f83da100-fa47-4fb7-a605-8ab249130651"
],
"NonLaborAssignments": [
{
"Id": "4bf6bace-6f56-4660-924f-fbc6abd7101b",
"ResourceId": "474a4dee-e7d9-458d-b626-52174b30fc0b",
"Quantity": 3.0
},
{
"Id": "4bf6bace-6f56-4660-924f-fbc6abd7101b",
"ResourceId": "474a4dee-e7d9-458d-b626-52174b30fc0b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "f87b4cab-dc61-491a-824a-1fdc5ce0f446",
"Type": 0,
"ResourceId": "4713a266-6766-489a-9ca9-c5c270b8964d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "986a6b6c-a0cc-4c3a-8d9c-2c560e8da28c",
"Start": "2026-10-09T16:06:19.5263297+00:00",
"Due": "2026-10-09T16:06:19.5263297+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "986a6b6c-a0cc-4c3a-8d9c-2c560e8da28c",
"Start": "2026-10-09T16:06:19.5263297+00:00",
"Due": "2026-10-09T16:06:19.5263297+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "f87b4cab-dc61-491a-824a-1fdc5ce0f446",
"Type": 0,
"ResourceId": "4713a266-6766-489a-9ca9-c5c270b8964d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "986a6b6c-a0cc-4c3a-8d9c-2c560e8da28c",
"Start": "2026-10-09T16:06:19.5263297+00:00",
"Due": "2026-10-09T16:06:19.5263297+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "986a6b6c-a0cc-4c3a-8d9c-2c560e8da28c",
"Start": "2026-10-09T16:06:19.5263297+00:00",
"Due": "2026-10-09T16:06:19.5263297+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "d242f6f7-f6d7-44e2-a71d-cc09d34353e6",
"WorkTypeParentId": "f6db7c38-2acb-4ebb-9b39-9ab4d605c884",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e626562e-718a-49f7-86b3-7dce5c47cd12",
"UPN": "4ada8624-1f8f-4d07-8404-f0cd9e845cea",
"PostDate": "2026-10-09T16:06:19.5263297+00:00",
"Comment": "sample string 4",
"CC": [
"d59ee005-6f37-4aed-a6ed-ad13f8b1c36e",
"a31f3f08-947e-4249-af90-6655796057be"
],
"Users": [
"0e0ba486-511f-4cea-a381-d1bd5b32d818",
"ff67099b-ccc1-4a0d-b3b6-b5d18651fee7"
]
},
{
"Id": "e626562e-718a-49f7-86b3-7dce5c47cd12",
"UPN": "4ada8624-1f8f-4d07-8404-f0cd9e845cea",
"PostDate": "2026-10-09T16:06:19.5263297+00:00",
"Comment": "sample string 4",
"CC": [
"d59ee005-6f37-4aed-a6ed-ad13f8b1c36e",
"a31f3f08-947e-4249-af90-6655796057be"
],
"Users": [
"0e0ba486-511f-4cea-a381-d1bd5b32d818",
"ff67099b-ccc1-4a0d-b3b6-b5d18651fee7"
]
}
],
"StartDate": "2026-10-09T16:06:19.5263297+00:00",
"DueDate": "2026-10-09T16:06:19.5263297+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"034f6283-384b-4334-83d1-319402c88959": "a953ac5a-2c05-4907-b818-cf771b33e899",
"477a293c-0a26-4579-84cc-0f1bad677a02": "aa86f50c-7859-49a3-9f33-f64d21614998"
},
"HasUpdates": true,
"Modified": "2026-10-09T16:06:19.5263297+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-09T16:06:19.5263297+00:00"
},
"LastComment": "2026-10-09T16:06:19.5263297+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c5a1ba06-f598-4099-84cb-d3e0d47578df",
"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": "2c0ac105-fbd1-4874-a027-1efb541a5f00",
"id": "ce55cf7c-69ba-4a74-af1b-2cbe1181d5c3",
"ConfigId": "5754ecfd-c621-4400-a65d-01935ad68aa5"
}