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": "427d64c7-faa1-49a5-a380-ed3c04c8ffa5",
"ParentTaskId": "ed5a4d6f-a097-4d38-900b-f7822f40c677",
"Integration": {
"IntegrationId": "7a094d2c-1b14-4d93-a112-df0effa653dd",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"53d2ba77-df42-4a77-8b10-b1699e235794": 2.0,
"4e2db150-eb5d-472b-8cfd-bf74c7f89e2d": 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": "256378af-d201-448c-aafc-8b93b80df179",
"Name": "sample string 1",
"Created": "2026-07-19T12:07:23.2374574+00:00",
"Modified": "2026-07-19T12:07:23.2374574+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"889152ec-315f-49e3-bb91-cd623791e87c",
"23b881a1-c0c9-4e5a-ad92-24fa39059e30"
],
"NonLaborAssignments": [
{
"Id": "25a1ac26-5fb5-44cf-914a-92fd601e0a30",
"ResourceId": "f98f4eec-bfa3-45b0-baf4-f2fe016a1f11",
"Quantity": 3.0
},
{
"Id": "25a1ac26-5fb5-44cf-914a-92fd601e0a30",
"ResourceId": "f98f4eec-bfa3-45b0-baf4-f2fe016a1f11",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "36b12f46-513a-4baf-9811-b90dc25a61f3",
"Type": 0,
"ResourceId": "e40d62f3-7341-4613-af30-e833d5e15c2d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "36b12f46-513a-4baf-9811-b90dc25a61f3",
"Type": 0,
"ResourceId": "e40d62f3-7341-4613-af30-e833d5e15c2d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "dce9879d-cebb-47a3-9176-6f6d5e2b7d22",
"WorkTypeParentId": "691b5f1d-bafc-40e2-b0ea-4c6c7c016a91",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8be1f455-9e76-4812-8eda-f8c9e9f224ed",
"UPN": "ceffbc67-b280-460f-9fff-8b81a3b9edbc",
"PostDate": "2026-07-19T12:07:23.2374574+00:00",
"Comment": "sample string 4",
"CC": [
"8674dedb-b66a-4bbd-baf3-db7125b0b0a7",
"d45c4d09-7c37-4dcf-b219-ef7be3466fd0"
],
"Users": [
"bc38e309-193b-4bec-808c-f77ac7cbddb4",
"7c3f8d75-5208-412d-8eca-abb51a550400"
]
},
{
"Id": "8be1f455-9e76-4812-8eda-f8c9e9f224ed",
"UPN": "ceffbc67-b280-460f-9fff-8b81a3b9edbc",
"PostDate": "2026-07-19T12:07:23.2374574+00:00",
"Comment": "sample string 4",
"CC": [
"8674dedb-b66a-4bbd-baf3-db7125b0b0a7",
"d45c4d09-7c37-4dcf-b219-ef7be3466fd0"
],
"Users": [
"bc38e309-193b-4bec-808c-f77ac7cbddb4",
"7c3f8d75-5208-412d-8eca-abb51a550400"
]
}
],
"StartDate": "2026-07-19T12:07:23.2374574+00:00",
"DueDate": "2026-07-19T12:07:23.2374574+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9ac34bb8-9004-4b3d-a9a1-b80b515de2da": "d20c3e1b-d506-44f4-87d0-20eaf082ef22",
"e02671a9-3b5f-4f93-9bba-0a41a11f9df4": "2c9d2d79-129a-4244-9ace-047d24bb1812"
},
"HasUpdates": true,
"Modified": "2026-07-19T12:07:23.2374574+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-19T12:07:23.2374574+00:00"
},
"LastComment": "2026-07-19T12:07:23.2374574+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ab3cd1ae-ebbe-4e59-94a9-a706677be568",
"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": "6412e85f-db96-435d-b56c-6b14ece9e8ea",
"id": "49d263ea-dcfe-4d85-bf7f-10c535b4e730",
"ConfigId": "4739a5ed-7b6c-4ae8-b6c9-85ad061da3ed"
}