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": "d63e9a31-e6d7-4804-9d4f-7142fe36324c",
"ParentTaskId": "35cad0e1-5566-4069-bc90-b3126781cb16",
"Integration": {
"IntegrationId": "9067ffb8-721b-4feb-b0c0-65114049fc0a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"87031852-cc53-41ef-b1f7-9d32ba812b70": 2.0,
"955ffd2c-c31c-40e9-b746-4cc7b1dd6f73": 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": "718f5df9-01a7-4702-bd19-5024b69274fa",
"Name": "sample string 1",
"Created": "2026-11-06T00:33:52.9168837+00:00",
"Modified": "2026-11-06T00:33:52.9168837+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"deef85ea-563e-42d6-828c-ac3b8ef8b937",
"45f7a1b2-57ab-480f-9a6d-e3ef2c94b284"
],
"NonLaborAssignments": [
{
"Id": "1a44302c-4d57-4435-b283-091b7698e1d0",
"ResourceId": "91268ca2-8225-4f5d-bae4-a574c85f9fe4",
"Quantity": 3.0
},
{
"Id": "1a44302c-4d57-4435-b283-091b7698e1d0",
"ResourceId": "91268ca2-8225-4f5d-bae4-a574c85f9fe4",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7526770d-6840-4fd9-be59-6a249e3b0079",
"Type": 0,
"ResourceId": "938acecf-9fb4-40c8-b34b-3326bb6123b1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "fef7ad69-0ce9-4417-acc3-427dac361462",
"Start": "2026-11-06T00:33:52.9168837+00:00",
"Due": "2026-11-06T00:33:52.9168837+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "fef7ad69-0ce9-4417-acc3-427dac361462",
"Start": "2026-11-06T00:33:52.9168837+00:00",
"Due": "2026-11-06T00:33:52.9168837+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "7526770d-6840-4fd9-be59-6a249e3b0079",
"Type": 0,
"ResourceId": "938acecf-9fb4-40c8-b34b-3326bb6123b1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "fef7ad69-0ce9-4417-acc3-427dac361462",
"Start": "2026-11-06T00:33:52.9168837+00:00",
"Due": "2026-11-06T00:33:52.9168837+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "fef7ad69-0ce9-4417-acc3-427dac361462",
"Start": "2026-11-06T00:33:52.9168837+00:00",
"Due": "2026-11-06T00:33:52.9168837+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "b240ad32-f741-45df-90d4-15a981a8d588",
"WorkTypeParentId": "8ed352df-e6d9-4c81-915b-52f887943e3b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3d389981-5c8d-45c7-89e3-5c0763088ff5",
"UPN": "c1f973c9-c5af-4d7f-a8bd-f0df93cad293",
"PostDate": "2026-11-06T00:33:52.9168837+00:00",
"Comment": "sample string 4",
"CC": [
"6a4b13b6-13c1-474c-b14c-ba4b649116de",
"0fcf756b-8370-4a6d-b55f-b90bf77e36ff"
],
"Users": [
"0b78d034-98fe-4a04-8868-77a0d896f469",
"96bac28c-f053-4d06-a403-557a27e8e302"
]
},
{
"Id": "3d389981-5c8d-45c7-89e3-5c0763088ff5",
"UPN": "c1f973c9-c5af-4d7f-a8bd-f0df93cad293",
"PostDate": "2026-11-06T00:33:52.9168837+00:00",
"Comment": "sample string 4",
"CC": [
"6a4b13b6-13c1-474c-b14c-ba4b649116de",
"0fcf756b-8370-4a6d-b55f-b90bf77e36ff"
],
"Users": [
"0b78d034-98fe-4a04-8868-77a0d896f469",
"96bac28c-f053-4d06-a403-557a27e8e302"
]
}
],
"StartDate": "2026-11-06T00:33:52.9168837+00:00",
"DueDate": "2026-11-06T00:33:52.9168837+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d8fe0a54-2e60-481a-be8a-f6d8b8b6d353": "54bbb26a-413e-455c-9d4d-302a9033c49e",
"478756e6-44e2-4ac9-a48a-807267318f1c": "894fcf1c-bce1-49e7-850f-4c26c305d2fa"
},
"HasUpdates": true,
"Modified": "2026-11-06T00:33:52.9168837+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-11-06T00:33:52.9168837+00:00"
},
"LastComment": "2026-11-06T00:33:52.9168837+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c7a4fc4b-4124-48a0-ba25-942764c52dc5",
"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": "9faa4510-1c36-45de-920b-f16201a42c39",
"id": "e575e221-4340-4fb2-a4fe-3860a01f13a1",
"ConfigId": "2abfb121-da50-4881-b472-7545c5f64b45"
}