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": "f9e6818b-39a0-4661-88ee-ab385cae23f4",
"ParentTaskId": "33afcc34-bc7c-4cc8-bf60-dd7d3daaf1b4",
"Integration": {
"IntegrationId": "c609fa11-1e33-4805-9308-bbefded8d603",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"6a9d5041-7751-4896-aaef-ba750c66b4bb": 2.0,
"d40a9e7f-c69e-4cce-bb5c-524a04a704e5": 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": "2e84276e-3983-4364-a7fa-c7dc6aaf6a9d",
"Name": "sample string 1",
"Created": "2026-10-07T23:56:29.5163043+00:00",
"Modified": "2026-10-07T23:56:29.5163043+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"fd8be656-7750-49b1-bdf4-6fea8f14ea4c",
"e5601f33-0bf9-456d-8eb0-ddb5654c3416"
],
"NonLaborAssignments": [
{
"Id": "bcf114c0-fb18-4298-91cf-011913edaabe",
"ResourceId": "e962f464-9f8e-4917-b9e7-4e32d54ea375",
"Quantity": 3.0
},
{
"Id": "bcf114c0-fb18-4298-91cf-011913edaabe",
"ResourceId": "e962f464-9f8e-4917-b9e7-4e32d54ea375",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "33a4addd-6d09-488b-8699-4534cd028831",
"Type": 0,
"ResourceId": "f0045c71-f8bc-4527-a10f-861d80892f66",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "75269931-c451-44a5-8c0c-3a0964a11689",
"Start": "2026-10-07T23:56:29.5163043+00:00",
"Due": "2026-10-07T23:56:29.5163043+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "75269931-c451-44a5-8c0c-3a0964a11689",
"Start": "2026-10-07T23:56:29.5163043+00:00",
"Due": "2026-10-07T23:56:29.5163043+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "33a4addd-6d09-488b-8699-4534cd028831",
"Type": 0,
"ResourceId": "f0045c71-f8bc-4527-a10f-861d80892f66",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "75269931-c451-44a5-8c0c-3a0964a11689",
"Start": "2026-10-07T23:56:29.5163043+00:00",
"Due": "2026-10-07T23:56:29.5163043+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "75269931-c451-44a5-8c0c-3a0964a11689",
"Start": "2026-10-07T23:56:29.5163043+00:00",
"Due": "2026-10-07T23:56:29.5163043+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "6852593e-a239-4b86-8d26-6425426cdd91",
"WorkTypeParentId": "82fc3463-474c-43ab-8858-4726315f4876",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "4fd55313-6b82-43d8-835b-67afa5d7bf59",
"UPN": "00859a4e-5400-4143-8d00-dc06e2d1c64f",
"PostDate": "2026-10-07T23:56:29.5163043+00:00",
"Comment": "sample string 4",
"CC": [
"4f3ab4a1-9443-4cbf-80cb-57a2c4d1e476",
"208e9596-c29f-44da-ba3a-897191d7b193"
],
"Users": [
"5c58cc87-f188-4ae8-b088-8e9a37e119e6",
"7f8b5c46-fa33-4255-a17b-fb3374b025d3"
]
},
{
"Id": "4fd55313-6b82-43d8-835b-67afa5d7bf59",
"UPN": "00859a4e-5400-4143-8d00-dc06e2d1c64f",
"PostDate": "2026-10-07T23:56:29.5163043+00:00",
"Comment": "sample string 4",
"CC": [
"4f3ab4a1-9443-4cbf-80cb-57a2c4d1e476",
"208e9596-c29f-44da-ba3a-897191d7b193"
],
"Users": [
"5c58cc87-f188-4ae8-b088-8e9a37e119e6",
"7f8b5c46-fa33-4255-a17b-fb3374b025d3"
]
}
],
"StartDate": "2026-10-07T23:56:29.5163043+00:00",
"DueDate": "2026-10-07T23:56:29.5163043+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"f416e087-ab8c-473d-bcd5-d3ea9ad8bb0a": "16defb12-a3a1-48a6-83c5-9ba2ca2fc2a9",
"d4c50023-d4a6-4e0d-97c0-706b08aa26a5": "83d4c1c3-2ecb-4bbe-b34e-48b3b1c539b0"
},
"HasUpdates": true,
"Modified": "2026-10-07T23:56:29.5163043+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-07T23:56:29.5163043+00:00"
},
"LastComment": "2026-10-07T23:56:29.5163043+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7a02e66c-36e9-4c5a-acf9-6f8331c02d31",
"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": "2d7a681d-aeb0-46c2-96a5-d8cabf14c8df",
"id": "b887d476-afb6-4d49-9f2f-8c07500cc18e",
"ConfigId": "aafee90f-1bbc-4d19-a777-5dc4796896a1"
}