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": "d9c37f29-1732-446b-89e4-6e70b9ecb7e4",
"ParentTaskId": "308520cc-b7bd-4883-b1ef-51ea6d37d9ea",
"Integration": {
"IntegrationId": "c64a2b4b-b0c7-40b7-a98c-593f8cad2f65",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"0d811b6a-5453-4594-be67-19c2407a17eb": 2.0,
"1c67f34e-9eae-4c8d-b65a-420107c1c6cd": 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": "9ff8e6af-3d47-49e4-a74c-19d86fe277aa",
"Name": "sample string 1",
"Created": "2026-07-18T07:43:01.7627285+00:00",
"Modified": "2026-07-18T07:43:01.7627285+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"920c7625-0358-490e-a33d-8d2f46b485e9",
"640f188c-b3b5-43c4-b60a-d68941fdf58a"
],
"NonLaborAssignments": [
{
"Id": "33548a44-0fea-4d64-a4c9-8690997f935c",
"ResourceId": "c9ed9008-db9d-42a4-96f3-2a24ea6e5253",
"Quantity": 3.0
},
{
"Id": "33548a44-0fea-4d64-a4c9-8690997f935c",
"ResourceId": "c9ed9008-db9d-42a4-96f3-2a24ea6e5253",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "4bc20c3f-dee7-46fe-b12e-366ded9c56d9",
"Type": 0,
"ResourceId": "a46a2b74-ae6a-4c15-816f-990c1f9ed64b",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "4bc20c3f-dee7-46fe-b12e-366ded9c56d9",
"Type": 0,
"ResourceId": "a46a2b74-ae6a-4c15-816f-990c1f9ed64b",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "18ab61c2-55f4-46c1-8729-4c3eff67c6f1",
"WorkTypeParentId": "8c4141aa-06ae-4875-aa40-843babee4f48",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "1507079d-3d6a-4a63-845a-0570b3af73fd",
"UPN": "30618112-9dc6-4e42-94c1-418798bad855",
"PostDate": "2026-07-18T07:43:01.7627285+00:00",
"Comment": "sample string 4",
"CC": [
"2ab549aa-a5b7-48e5-8892-7754e8b9b610",
"a9d5f2d0-f660-4c45-bf5f-433af234da76"
],
"Users": [
"c87d65b5-4dd8-46ec-9375-392f10debed6",
"e2f2a93a-ed72-4ddc-a883-d0a50fc24ebc"
]
},
{
"Id": "1507079d-3d6a-4a63-845a-0570b3af73fd",
"UPN": "30618112-9dc6-4e42-94c1-418798bad855",
"PostDate": "2026-07-18T07:43:01.7627285+00:00",
"Comment": "sample string 4",
"CC": [
"2ab549aa-a5b7-48e5-8892-7754e8b9b610",
"a9d5f2d0-f660-4c45-bf5f-433af234da76"
],
"Users": [
"c87d65b5-4dd8-46ec-9375-392f10debed6",
"e2f2a93a-ed72-4ddc-a883-d0a50fc24ebc"
]
}
],
"StartDate": "2026-07-18T07:43:01.7627285+00:00",
"DueDate": "2026-07-18T07:43:01.7627285+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e1586967-313f-461f-ab3d-6a617f6f87b2": "05127494-e9c4-488d-b40d-349e76520f7a",
"141e2aff-c564-43eb-8ad3-92f66fc28125": "798d5ed6-b63a-4ccc-b6b8-42c02338b89c"
},
"HasUpdates": true,
"Modified": "2026-07-18T07:43:01.7627285+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-18T07:43:01.7627285+00:00"
},
"LastComment": "2026-07-18T07:43:01.7627285+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ff203bab-cf83-4cd7-a80f-5c0d3ac82b24",
"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": "e04d34f3-993e-4292-ad76-6639a5fffcb8",
"id": "3dd76429-fde9-4f4a-813f-54e4570490e7",
"ConfigId": "aed4b801-a584-46a5-b454-e188215bc4e8"
}