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": "bc73c07c-1715-4bb5-9341-a47066f6adb2",
"ParentTaskId": "24e12b1f-cf6d-4afe-9201-e08afcd8f47e",
"Integration": {
"IntegrationId": "0b8389b5-2b57-4219-8820-2113656a10ad",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"ed9d679d-6be7-4964-8563-19bdb64441c7": 2.0,
"0d3605ab-e960-4b22-8cb5-4c5e23d39f51": 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": "7ec70868-ff27-4e2b-9467-51b50937dd94",
"Name": "sample string 1",
"Created": "2026-07-26T01:10:40.7769492+00:00",
"Modified": "2026-07-26T01:10:40.7769492+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c0c3ed0b-3ca1-4659-85b3-5a743cb99a29",
"c182897e-37d4-42a4-8766-4eff833b470a"
],
"NonLaborAssignments": [
{
"Id": "67ae5c60-429f-479c-9929-4ba882eef674",
"ResourceId": "a961e1f4-bc6e-4603-bb07-5b1cca60fa27",
"Quantity": 3.0
},
{
"Id": "67ae5c60-429f-479c-9929-4ba882eef674",
"ResourceId": "a961e1f4-bc6e-4603-bb07-5b1cca60fa27",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6333267a-222a-47e8-84b6-44433c3c5451",
"Type": 0,
"ResourceId": "d784df60-2702-4218-a4de-b71ee1c72c56",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "6333267a-222a-47e8-84b6-44433c3c5451",
"Type": 0,
"ResourceId": "d784df60-2702-4218-a4de-b71ee1c72c56",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "a6a1675e-6adc-4042-af62-d69dab6a0bda",
"WorkTypeParentId": "63bcbc42-b924-466a-943f-017d00b4cdc0",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b348e061-a5a3-4a6b-a454-a316284aea55",
"UPN": "b34c92e4-aa0d-431c-83a8-c7669e6b725d",
"PostDate": "2026-07-26T01:10:40.7769492+00:00",
"Comment": "sample string 4",
"CC": [
"a8456f53-04b1-4f39-a84c-fc3fa9fe293e",
"18d755e0-132a-44b6-b9ac-fc24b4e21333"
],
"Users": [
"b71828f9-4906-4669-b92a-6bcd3357017b",
"9b67d22d-89d4-4cde-a1db-6202ee20e9a3"
]
},
{
"Id": "b348e061-a5a3-4a6b-a454-a316284aea55",
"UPN": "b34c92e4-aa0d-431c-83a8-c7669e6b725d",
"PostDate": "2026-07-26T01:10:40.7769492+00:00",
"Comment": "sample string 4",
"CC": [
"a8456f53-04b1-4f39-a84c-fc3fa9fe293e",
"18d755e0-132a-44b6-b9ac-fc24b4e21333"
],
"Users": [
"b71828f9-4906-4669-b92a-6bcd3357017b",
"9b67d22d-89d4-4cde-a1db-6202ee20e9a3"
]
}
],
"StartDate": "2026-07-26T01:10:40.7769492+00:00",
"DueDate": "2026-07-26T01:10:40.7769492+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b3a5d6db-9e36-41db-993f-8da868023c7d": "dbcfcad7-a9aa-4b4e-85ab-a6fb90c3aa5b",
"4e0e28f6-ca5d-474a-8146-b7fe8714a3d4": "507ea415-a88c-451e-b543-7fa092bfc33e"
},
"HasUpdates": true,
"Modified": "2026-07-26T01:10:40.7769492+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-07-26T01:10:40.7769492+00:00"
},
"LastComment": "2026-07-26T01:10:40.7769492+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "76202cde-56cc-46f4-a1a0-aa6823511387",
"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": "3bfb16c4-cc1c-4c69-85aa-b835d1842c2f",
"id": "285784f3-cf7b-4f04-87b4-321b5c2050dc",
"ConfigId": "4a0e8e0e-35a0-46ec-a831-9a00e5532da9"
}