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": "55e3337d-2862-4b9d-b555-c66a61640543",
"ParentTaskId": "a4e0b590-6b0f-42ea-8111-ecf5304297ce",
"Integration": {
"IntegrationId": "4bd5ad0c-c730-4db1-b192-0c141fd1d034",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2bc6b5b3-b0a4-468c-9122-66e66d22e241": 2.0,
"6e043430-ac47-4b65-b927-b35ec6fe683b": 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": "2b72b46f-5db0-4688-b868-81a9c1036490",
"Name": "sample string 1",
"Created": "2026-06-29T17:36:47.0670157+00:00",
"Modified": "2026-06-29T17:36:47.0670157+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f992d004-c207-4589-81d9-564c48caaf15",
"add83a23-c509-4a3e-81f8-4892447160df"
],
"NonLaborAssignments": [
{
"Id": "555c0878-a5ab-479b-ae37-b9a2781b4636",
"ResourceId": "6bec578e-14db-423c-87e7-d28633bfdde8",
"Quantity": 3.0
},
{
"Id": "555c0878-a5ab-479b-ae37-b9a2781b4636",
"ResourceId": "6bec578e-14db-423c-87e7-d28633bfdde8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "2fe9c957-cdd1-44c3-97c5-f08a1adcf000",
"Type": 0,
"ResourceId": "024e5c31-f449-4e82-ac7f-750defaa903e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "2fe9c957-cdd1-44c3-97c5-f08a1adcf000",
"Type": 0,
"ResourceId": "024e5c31-f449-4e82-ac7f-750defaa903e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "a81c90bd-8a09-4df0-8e33-203d28be54b4",
"WorkTypeParentId": "1fc93a74-e66f-4e44-a04f-149cdace64ba",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "6a6a5735-ee34-488b-859f-a3bb58a83166",
"UPN": "1b41be8e-3df5-47dc-97a0-2fb222db2b84",
"PostDate": "2026-06-29T17:36:47.0670157+00:00",
"Comment": "sample string 4",
"CC": [
"df3b4bc6-b35b-45d4-8c55-748bac5f4fd6",
"182c100c-bf2e-499a-bea7-3cbc6485da58"
],
"Users": [
"4b1d17ff-e049-49c2-a049-519c9d032df8",
"b2d0b956-afc4-41b4-a27b-0736eb2910c7"
]
},
{
"Id": "6a6a5735-ee34-488b-859f-a3bb58a83166",
"UPN": "1b41be8e-3df5-47dc-97a0-2fb222db2b84",
"PostDate": "2026-06-29T17:36:47.0670157+00:00",
"Comment": "sample string 4",
"CC": [
"df3b4bc6-b35b-45d4-8c55-748bac5f4fd6",
"182c100c-bf2e-499a-bea7-3cbc6485da58"
],
"Users": [
"4b1d17ff-e049-49c2-a049-519c9d032df8",
"b2d0b956-afc4-41b4-a27b-0736eb2910c7"
]
}
],
"StartDate": "2026-06-29T17:36:47.0670157+00:00",
"DueDate": "2026-06-29T17:36:47.0670157+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7064008b-8ba5-4245-aa4d-77c0d1fd8e15": "0aa1c6dd-c0cb-45b7-91ef-94a6d0ad1442",
"bbd7d5fb-5269-4ef5-8934-b42609968bbf": "80f17633-3dd3-43d4-9d49-119f65cd5fb4"
},
"HasUpdates": true,
"Modified": "2026-06-29T17:36:47.0670157+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-29T17:36:47.0670157+00:00"
},
"LastComment": "2026-06-29T17:36:47.0670157+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "961cc219-122b-414e-a6e3-e1d5485d1caa",
"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": "44934bd9-7e68-4a11-b9d5-8f30afee562d",
"id": "03d6f19c-aaf4-452c-94b9-c8d1104055d5",
"ConfigId": "493494cb-6a8a-4be7-8488-8163ca63c536"
}