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": "c6f40b18-8c2a-48ba-a45a-a8dbbe98c42c",
"ParentTaskId": "0cf07163-3959-44d1-9087-a24a62fce447",
"Integration": {
"IntegrationId": "3e2d1e7e-f27b-4962-a310-a538c2764362",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"65eda798-61d5-4fb9-a7fd-637ba3476451": 2.0,
"1fc0b029-d8b1-47fe-bbb5-7a7a73d08f13": 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": "d583ede5-8ba8-42d4-8251-b65b20d097d6",
"Name": "sample string 1",
"Created": "2026-07-11T13:25:23.1218022+00:00",
"Modified": "2026-07-11T13:25:23.1218022+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1ea6092d-667e-49d4-9a8c-80bd16e41cad",
"8c5c4e40-9743-40a7-9f42-6ab0b903344e"
],
"NonLaborAssignments": [
{
"Id": "cb1caf61-870d-4a68-8f2f-58871a970139",
"ResourceId": "6c8b6ca7-6fd3-4b94-912a-4aed1e1530ac",
"Quantity": 3.0
},
{
"Id": "cb1caf61-870d-4a68-8f2f-58871a970139",
"ResourceId": "6c8b6ca7-6fd3-4b94-912a-4aed1e1530ac",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "4310532e-519c-4849-b411-69c0aa461d5e",
"Type": 0,
"ResourceId": "8139835a-8a2c-4fbf-a3e7-bd5a3bbae8be",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "4310532e-519c-4849-b411-69c0aa461d5e",
"Type": 0,
"ResourceId": "8139835a-8a2c-4fbf-a3e7-bd5a3bbae8be",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "2cb31001-1b3f-45de-b764-bd3b62e0b09f",
"WorkTypeParentId": "15297ac9-4bc9-458c-9384-7ade486526fc",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f560f13e-7480-4919-8a0b-dc37747b626c",
"UPN": "80261cf8-522b-4b5b-b179-38cad68578a6",
"PostDate": "2026-07-11T13:25:23.1218022+00:00",
"Comment": "sample string 4",
"CC": [
"42240ae4-2d20-44a8-bdb3-170da4a309e2",
"0c8ab952-3aa7-4c5d-ada0-e3e0db2b1336"
],
"Users": [
"f6fa5e4c-a099-4ce8-a3db-d94fd0062dc5",
"52389cb2-dd9c-4553-bf87-98260f8af99f"
]
},
{
"Id": "f560f13e-7480-4919-8a0b-dc37747b626c",
"UPN": "80261cf8-522b-4b5b-b179-38cad68578a6",
"PostDate": "2026-07-11T13:25:23.1218022+00:00",
"Comment": "sample string 4",
"CC": [
"42240ae4-2d20-44a8-bdb3-170da4a309e2",
"0c8ab952-3aa7-4c5d-ada0-e3e0db2b1336"
],
"Users": [
"f6fa5e4c-a099-4ce8-a3db-d94fd0062dc5",
"52389cb2-dd9c-4553-bf87-98260f8af99f"
]
}
],
"StartDate": "2026-07-11T13:25:23.1218022+00:00",
"DueDate": "2026-07-11T13:25:23.1218022+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7ac46768-0720-4a24-8fd9-91084fdf34b5": "13433518-e9fe-417d-8c4e-573e50eb85a1",
"672eecde-e73a-487d-99f2-45883435faa2": "8469e0cc-e57b-45eb-806e-b49849da7ddc"
},
"HasUpdates": true,
"Modified": "2026-07-11T13:25:23.1218022+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-11T13:25:23.1218022+00:00"
},
"LastComment": "2026-07-11T13:25:23.1218022+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "8b5ee0a4-a15e-4ac2-955a-34a21b22f8b6",
"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": "9ad7e423-7110-4f76-b99b-495115377954",
"id": "8b912bdd-ba6f-488d-b7f8-3afbbde83a41",
"ConfigId": "3e21ea3a-cff4-4b41-970a-18f2527a1f0b"
}