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": "77c7bdcc-e5ca-473b-ba04-31d0d5a70cad",
"ParentTaskId": "c2834a71-98a5-4bb2-ab11-ab6610b52033",
"Integration": {
"IntegrationId": "ff587e54-7ea3-44f4-b311-5a5e4fdfde92",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"655a49bf-a6a1-46af-916e-2ac77beb040d": 2.0,
"3370ca67-1563-4c72-9e7d-e2af89e39d50": 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": "242b6ea6-428c-4a81-9681-bbb05ba60d4a",
"Name": "sample string 1",
"Created": "2026-09-30T20:17:52.5381678+00:00",
"Modified": "2026-09-30T20:17:52.5381678+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0e619d39-ff55-4b51-8462-ff6764e3d382",
"91c8e2a5-da79-4053-9886-99c8a4b14dc0"
],
"NonLaborAssignments": [
{
"Id": "c8c9c671-9db0-4dee-977c-3443ae9cfa0d",
"ResourceId": "3ceaa00b-cb14-455a-85a6-cba9c678aed8",
"Quantity": 3.0
},
{
"Id": "c8c9c671-9db0-4dee-977c-3443ae9cfa0d",
"ResourceId": "3ceaa00b-cb14-455a-85a6-cba9c678aed8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "0645b5a1-4ab4-40ee-96d6-b177a113ba74",
"Type": 0,
"ResourceId": "510ce30b-252f-4611-88eb-0778f0b5bece",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b5a3ccff-992f-45c3-becc-9733a5f1932a",
"Start": "2026-09-30T20:17:52.5381678+00:00",
"Due": "2026-09-30T20:17:52.5381678+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b5a3ccff-992f-45c3-becc-9733a5f1932a",
"Start": "2026-09-30T20:17:52.5381678+00:00",
"Due": "2026-09-30T20:17:52.5381678+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "0645b5a1-4ab4-40ee-96d6-b177a113ba74",
"Type": 0,
"ResourceId": "510ce30b-252f-4611-88eb-0778f0b5bece",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b5a3ccff-992f-45c3-becc-9733a5f1932a",
"Start": "2026-09-30T20:17:52.5381678+00:00",
"Due": "2026-09-30T20:17:52.5381678+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b5a3ccff-992f-45c3-becc-9733a5f1932a",
"Start": "2026-09-30T20:17:52.5381678+00:00",
"Due": "2026-09-30T20:17:52.5381678+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "49b18c35-4d85-4478-be51-7f88e0d0e62a",
"WorkTypeParentId": "8a6a3bf8-6d21-495d-9c30-af176b8832bd",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "1baed759-e78e-4166-b814-b40cb55a4aad",
"UPN": "b7bcaa7f-180e-463e-87eb-a6c7f1448e3b",
"PostDate": "2026-09-30T20:17:52.5381678+00:00",
"Comment": "sample string 4",
"CC": [
"537cfd7c-144e-4036-b773-9d66d152580e",
"57c28ffb-3273-450c-8e4e-85cafa688cbe"
],
"Users": [
"ef6053a8-4557-4531-86ae-4110b145b440",
"fd4f49d9-b3c4-4da5-90d1-6343d7b9fb47"
]
},
{
"Id": "1baed759-e78e-4166-b814-b40cb55a4aad",
"UPN": "b7bcaa7f-180e-463e-87eb-a6c7f1448e3b",
"PostDate": "2026-09-30T20:17:52.5381678+00:00",
"Comment": "sample string 4",
"CC": [
"537cfd7c-144e-4036-b773-9d66d152580e",
"57c28ffb-3273-450c-8e4e-85cafa688cbe"
],
"Users": [
"ef6053a8-4557-4531-86ae-4110b145b440",
"fd4f49d9-b3c4-4da5-90d1-6343d7b9fb47"
]
}
],
"StartDate": "2026-09-30T20:17:52.5381678+00:00",
"DueDate": "2026-09-30T20:17:52.5381678+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4b894a75-a703-4b6b-9b03-1f345d34668e": "3b5987e0-7618-4283-9f85-e13dc9c55fed",
"97a25a76-eef5-4e9a-a511-e12ce66a89c0": "daface15-a7d5-40d5-855e-8e8adb79c504"
},
"HasUpdates": true,
"Modified": "2026-09-30T20:17:52.5537963+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-09-30T20:17:52.5537963+00:00"
},
"LastComment": "2026-09-30T20:17:52.5537963+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7780166a-f492-4f1e-8348-108ece763648",
"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": "a58c8c2c-1aa5-498e-93b4-6dfb72b37aa3",
"id": "82037631-37b4-4a9a-9195-ba9bccdd872e",
"ConfigId": "2b961455-2aa3-4ba4-aa4a-2e164e0ca36f"
}