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": "bdd5c11b-f591-4849-9f03-e66c9e4ef7c3",
"ParentTaskId": "651d72a6-d0b0-4c29-b0d0-ba33caae5788",
"Integration": {
"IntegrationId": "eae6dd1d-1865-4f0e-9e09-883ced5641f6",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d1962bb9-3340-4afb-9bd8-35732f78b0cc": 2.0,
"e354767e-3642-4dd1-8d28-1c8d722e2fe3": 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": "5cab37a5-e4a0-4284-8fe9-de90dbe9afee",
"Name": "sample string 1",
"Created": "2026-07-17T06:46:11.5778177+00:00",
"Modified": "2026-07-17T06:46:11.5778177+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"52b91013-55ed-4294-8233-bddc35dd86d0",
"1a32f60a-f2f0-43f4-809f-5d96d57128ec"
],
"NonLaborAssignments": [
{
"Id": "094be2a4-bc5a-4cb3-8925-38c6315e1d9c",
"ResourceId": "a82efc33-5c33-4806-94cf-1549d0abd588",
"Quantity": 3.0
},
{
"Id": "094be2a4-bc5a-4cb3-8925-38c6315e1d9c",
"ResourceId": "a82efc33-5c33-4806-94cf-1549d0abd588",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6f64df01-c7ab-4190-9239-a82fc6352d82",
"Type": 0,
"ResourceId": "a10fdbe3-9be4-46d3-906e-f71dad6a6a1e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "6f64df01-c7ab-4190-9239-a82fc6352d82",
"Type": 0,
"ResourceId": "a10fdbe3-9be4-46d3-906e-f71dad6a6a1e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "29ad6747-8d5b-4588-b110-d133dd4a3a4e",
"WorkTypeParentId": "6a58382d-42c9-4025-bcde-2c90bad55985",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "5eebd62d-65cd-4cba-a74b-40bcb7600f5a",
"UPN": "8910539b-a5cd-49e3-9497-80d978c2a47b",
"PostDate": "2026-07-17T06:46:11.5778177+00:00",
"Comment": "sample string 4",
"CC": [
"3291db16-c087-4ff9-ac3c-0bc858c9dcff",
"7933865c-d930-4eeb-a58a-dfdd93fd704e"
],
"Users": [
"31019eb2-a596-409c-b53a-a2e84fc58d92",
"c060800d-6f3f-4b19-a1f6-0503b45e2ed3"
]
},
{
"Id": "5eebd62d-65cd-4cba-a74b-40bcb7600f5a",
"UPN": "8910539b-a5cd-49e3-9497-80d978c2a47b",
"PostDate": "2026-07-17T06:46:11.5778177+00:00",
"Comment": "sample string 4",
"CC": [
"3291db16-c087-4ff9-ac3c-0bc858c9dcff",
"7933865c-d930-4eeb-a58a-dfdd93fd704e"
],
"Users": [
"31019eb2-a596-409c-b53a-a2e84fc58d92",
"c060800d-6f3f-4b19-a1f6-0503b45e2ed3"
]
}
],
"StartDate": "2026-07-17T06:46:11.5778177+00:00",
"DueDate": "2026-07-17T06:46:11.5778177+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e28dd47e-dc19-44e9-9957-805bdc194516": "7f4e3b98-3fb5-4c58-a3a9-de72242b4259",
"f5afea1c-0313-4644-93c0-4fef98bbe85d": "6a7d0617-5acf-48c9-8b4c-3cf09e146d97"
},
"HasUpdates": true,
"Modified": "2026-07-17T06:46:11.5778177+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-17T06:46:11.5778177+00:00"
},
"LastComment": "2026-07-17T06:46:11.5778177+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f2a32f43-8874-45f1-8410-ed1e81136d11",
"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": "af726761-4bfe-4aed-a80a-7264d7229e64",
"id": "06160ca9-579d-425e-a36f-48010960540b",
"ConfigId": "9a3a29df-db53-4319-8ee2-c8b33ebf6e16"
}