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": "f3354606-e758-458a-b405-a347e21c01ed",
"ParentTaskId": "e79db131-fab1-4257-92cb-880cefca6a41",
"Integration": {
"IntegrationId": "95f1f7dc-a37e-4e1b-a6af-93bea737e466",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d9fd0845-570f-4365-a949-dc1ab4873794": 2.0,
"d5671adf-bd6e-46be-a7ec-e3c0fcc9065c": 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": "c44195fc-90ce-43e3-89c1-15b4ca42393f",
"Name": "sample string 1",
"Created": "2026-06-10T16:08:33.0734811+00:00",
"Modified": "2026-06-10T16:08:33.0734811+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c4a467c1-3ec3-4b5d-8ffe-99f3547d7675",
"0ef49946-e8bd-4b2c-a525-6a7600be8752"
],
"NonLaborAssignments": [
{
"Id": "e2d05791-f1bd-4e2b-85ee-aa10e5b77910",
"ResourceId": "6e224478-f6f1-4793-b4da-d9994ec557a0",
"Quantity": 3.0
},
{
"Id": "e2d05791-f1bd-4e2b-85ee-aa10e5b77910",
"ResourceId": "6e224478-f6f1-4793-b4da-d9994ec557a0",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "0dcdf2ae-1793-4e9e-b3f8-d165d28702cc",
"Type": 0,
"ResourceId": "10f14054-4e16-4e5a-bc63-d352e1a04994",
"Units": 3.0
},
{
"Id": "0dcdf2ae-1793-4e9e-b3f8-d165d28702cc",
"Type": 0,
"ResourceId": "10f14054-4e16-4e5a-bc63-d352e1a04994",
"Units": 3.0
}
],
"ParentId": "4f30f52d-6a35-4e33-a03a-ee8279e15cfb",
"WorkTypeParentId": "c9f42343-b179-4fc3-989c-68ddc6e92e6c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "cfbfa3fe-594c-4848-95c0-68c61a629587",
"UPN": "a24ad2e4-99ec-45f5-8e58-bcbca0d10102",
"PostDate": "2026-06-10T16:08:33.0734811+00:00",
"Comment": "sample string 4",
"CC": [
"bff7a04c-3477-4424-9297-7aa00a8c3355",
"53ea2dfa-13e5-48d9-b636-973b6ecdc2c3"
],
"Users": [
"55f1f9e3-8afe-460c-962c-341977dd4a19",
"31bef05a-8dc6-4531-b90b-81b665f71bcb"
]
},
{
"Id": "cfbfa3fe-594c-4848-95c0-68c61a629587",
"UPN": "a24ad2e4-99ec-45f5-8e58-bcbca0d10102",
"PostDate": "2026-06-10T16:08:33.0734811+00:00",
"Comment": "sample string 4",
"CC": [
"bff7a04c-3477-4424-9297-7aa00a8c3355",
"53ea2dfa-13e5-48d9-b636-973b6ecdc2c3"
],
"Users": [
"55f1f9e3-8afe-460c-962c-341977dd4a19",
"31bef05a-8dc6-4531-b90b-81b665f71bcb"
]
}
],
"StartDate": "2026-06-10T16:08:33.0734811+00:00",
"DueDate": "2026-06-10T16:08:33.0734811+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"c1c3cc9d-9b76-4a7a-a078-59af23fd10c6": "66a7634e-4d94-4e26-9e33-8b876688adda",
"438063a2-8a1d-4fc1-9a75-816a02aab04f": "555e3346-c3cf-47a2-b61a-332bd65c7627"
},
"HasUpdates": true,
"Modified": "2026-06-10T16:08:33.0734811+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-10T16:08:33.0891168+00:00"
},
"LastComment": "2026-06-10T16:08:33.0891168+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "143407c1-78a5-40d8-87c7-8fcd56818410",
"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": "11039638-4ea1-4da0-9f38-870927995c07",
"id": "97e735d8-600c-4877-99cd-d42def43ac82",
"ConfigId": "bb39f866-3b4d-4b13-83a5-09a258bfb108"
}