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": "512c1338-d978-470b-baa3-b8818b30c18b",
"ParentTaskId": "06204c27-7e4e-4a31-9d21-7114ad0570c1",
"Integration": {
"IntegrationId": "ed707e8c-cb7b-428d-84a6-5fcc91e6d7e2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1dfad590-c20d-4591-8278-1c103992123b": 2.0,
"878289f7-e61d-47c1-ac3e-001ba7a91b30": 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": "c04b7699-b29c-4c2e-bccd-970818255f83",
"Name": "sample string 1",
"Created": "2026-10-05T03:51:25.3877487+00:00",
"Modified": "2026-10-05T03:51:25.3877487+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"207b0651-07b9-4259-9887-c1bc9b4a3cb8",
"a490a12a-7754-48dc-a1cb-501d3b4dc53f"
],
"NonLaborAssignments": [
{
"Id": "723c6ff8-ce6a-4f55-8dbe-a7b199d534aa",
"ResourceId": "a8639a3b-804a-4df5-a1ce-d2fda6304853",
"Quantity": 3.0
},
{
"Id": "723c6ff8-ce6a-4f55-8dbe-a7b199d534aa",
"ResourceId": "a8639a3b-804a-4df5-a1ce-d2fda6304853",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b1e763b9-ec2a-4026-9794-bd7fa6bb4552",
"Type": 0,
"ResourceId": "10e91778-1709-4552-8008-431b45e43de4",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7d215630-45aa-43c5-bfda-58761e8c661a",
"Start": "2026-10-05T03:51:25.3877487+00:00",
"Due": "2026-10-05T03:51:25.3877487+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7d215630-45aa-43c5-bfda-58761e8c661a",
"Start": "2026-10-05T03:51:25.3877487+00:00",
"Due": "2026-10-05T03:51:25.3877487+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "b1e763b9-ec2a-4026-9794-bd7fa6bb4552",
"Type": 0,
"ResourceId": "10e91778-1709-4552-8008-431b45e43de4",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7d215630-45aa-43c5-bfda-58761e8c661a",
"Start": "2026-10-05T03:51:25.3877487+00:00",
"Due": "2026-10-05T03:51:25.3877487+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7d215630-45aa-43c5-bfda-58761e8c661a",
"Start": "2026-10-05T03:51:25.3877487+00:00",
"Due": "2026-10-05T03:51:25.3877487+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "2eee7e2e-0201-425d-a0e0-882470c07b9f",
"WorkTypeParentId": "847f4b53-246c-4e51-8b1b-0425c2494664",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "332b2712-3eb2-4242-a6d7-8fd40a8d1034",
"UPN": "1e91b035-be01-44ab-889c-f78ee4d0160b",
"PostDate": "2026-10-05T03:51:25.3877487+00:00",
"Comment": "sample string 4",
"CC": [
"7c847cd1-3257-4247-a750-41df84b048ca",
"7ce968e2-85dc-442a-9755-db1bba170131"
],
"Users": [
"7a6d88a5-e810-4490-b8ac-91d9171296bb",
"ecdddb32-175b-4d10-bf5b-980b3db0a005"
]
},
{
"Id": "332b2712-3eb2-4242-a6d7-8fd40a8d1034",
"UPN": "1e91b035-be01-44ab-889c-f78ee4d0160b",
"PostDate": "2026-10-05T03:51:25.3877487+00:00",
"Comment": "sample string 4",
"CC": [
"7c847cd1-3257-4247-a750-41df84b048ca",
"7ce968e2-85dc-442a-9755-db1bba170131"
],
"Users": [
"7a6d88a5-e810-4490-b8ac-91d9171296bb",
"ecdddb32-175b-4d10-bf5b-980b3db0a005"
]
}
],
"StartDate": "2026-10-05T03:51:25.3877487+00:00",
"DueDate": "2026-10-05T03:51:25.3877487+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d3bf6ad5-7f21-4d8e-9467-3afb3dce3e8c": "27fe13bb-dd26-45bf-8a84-68647a73aec9",
"f7c210cb-661f-4899-a7c6-827f785a2133": "926ee37f-d187-485c-8485-5fb7e1d030e2"
},
"HasUpdates": true,
"Modified": "2026-10-05T03:51:25.3877487+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-10-05T03:51:25.3877487+00:00"
},
"LastComment": "2026-10-05T03:51:25.3877487+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0599e774-7da0-4c40-b513-afbbd2da73c5",
"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": "c4147883-e12c-4883-b880-27f3d98cda56",
"id": "b8aa2e78-0915-4872-8b64-e99651d4c5cb",
"ConfigId": "7062d6e0-56b0-45ea-ae1e-6374f4b53514"
}