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": "34b8c25b-1213-43bd-af04-71f36e207d9a",
"ParentTaskId": "ae401fd2-7e09-4b4c-8e06-e88768d2530c",
"Integration": {
"IntegrationId": "9b646d37-7058-4319-b47e-3c89a178ee2e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e3dd6958-c29c-4d85-bd50-56b980fb6e96": 2.0,
"d5c5f193-cca3-4b90-a9f0-e249ca747f42": 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": "5b2d51db-9566-4f70-958b-c3cafa2d0cf7",
"Name": "sample string 1",
"Created": "2026-06-29T20:57:44.0952105+00:00",
"Modified": "2026-06-29T20:57:44.0952105+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"4f794160-4d4d-42a5-8199-4e4854fbfbaa",
"faebb59a-9f66-4e1d-bd43-83373dbfd0bb"
],
"NonLaborAssignments": [
{
"Id": "4f120f9c-d778-464d-a393-4a58438a0a23",
"ResourceId": "a199995f-9f37-463b-8000-8fe6ef3ef9ce",
"Quantity": 3.0
},
{
"Id": "4f120f9c-d778-464d-a393-4a58438a0a23",
"ResourceId": "a199995f-9f37-463b-8000-8fe6ef3ef9ce",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b022db86-5672-4b44-8b0d-09d98f98d0af",
"Type": 0,
"ResourceId": "31ef610b-a43e-412a-aa3a-295798d5abe3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "b022db86-5672-4b44-8b0d-09d98f98d0af",
"Type": 0,
"ResourceId": "31ef610b-a43e-412a-aa3a-295798d5abe3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "3f8e40ce-38ed-4bf8-973a-5a4c9bf8fd77",
"WorkTypeParentId": "92555105-9de9-4da0-bc64-1afea584da9d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "cbbde9d4-6b10-4ec0-b0c5-de1f849d629f",
"UPN": "6527c9f5-e152-4d81-b791-473965511998",
"PostDate": "2026-06-29T20:57:44.0952105+00:00",
"Comment": "sample string 4",
"CC": [
"81d4595f-2a31-4026-a652-df6b56148740",
"1757c52e-5d10-4f42-920d-3cffc0abe829"
],
"Users": [
"da95070c-0944-4b7f-8511-0e5e6a93d496",
"d48ca385-0284-41a2-80aa-093e2c2d956b"
]
},
{
"Id": "cbbde9d4-6b10-4ec0-b0c5-de1f849d629f",
"UPN": "6527c9f5-e152-4d81-b791-473965511998",
"PostDate": "2026-06-29T20:57:44.0952105+00:00",
"Comment": "sample string 4",
"CC": [
"81d4595f-2a31-4026-a652-df6b56148740",
"1757c52e-5d10-4f42-920d-3cffc0abe829"
],
"Users": [
"da95070c-0944-4b7f-8511-0e5e6a93d496",
"d48ca385-0284-41a2-80aa-093e2c2d956b"
]
}
],
"StartDate": "2026-06-29T20:57:44.0952105+00:00",
"DueDate": "2026-06-29T20:57:44.0952105+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0bc8866b-8311-4d9e-bd01-6d52e460a716": "097583c0-203a-4b5a-b529-86c2d324db27",
"d2d8e1a4-1115-4440-ad15-eea943a648d4": "14d44054-1b49-415b-8e0b-4048d332a5f5"
},
"HasUpdates": true,
"Modified": "2026-06-29T20:57:44.0952105+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-06-29T20:57:44.0952105+00:00"
},
"LastComment": "2026-06-29T20:57:44.0952105+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f51dd9eb-226b-42f4-a488-29bd341f58ed",
"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": "0462efb6-12c2-41c1-8b0c-54fde28317af",
"id": "afa82186-7637-4ca0-9468-7bbfb68d4970",
"ConfigId": "188c0a97-3ef2-4657-af52-fd70e35d171d"
}