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": "5a556131-5f8d-4c7f-b753-42d067da7150",
"ParentTaskId": "87ef198c-fad8-4869-964c-8a739b96f536",
"Integration": {
"IntegrationId": "20668bd1-2302-4531-8ba5-9e96923ea382",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"51e61efb-2815-410b-9e91-1b509cd66e29": 2.0,
"668a1bb3-31c3-499a-bd64-51ae64c167d5": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "d1d946df-fa67-4a49-96b6-9fb93bd59564",
"Name": "sample string 1",
"Created": "2026-03-27T17:44:28.8775643+00:00",
"Modified": "2026-03-27T17:44:28.8775643+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"858a4132-e20c-4a2d-aa5b-28614954cfa4",
"0813bb29-ab41-4fab-bcc3-d9070054b3fe"
],
"NonLaborAssignments": [
{
"Id": "1bee60a5-a74c-4e53-862b-daaccdfb5c4f",
"ResourceId": "7bf1dc58-69c2-4bcc-b547-bb1e920bafce",
"Quantity": 3.0
},
{
"Id": "1bee60a5-a74c-4e53-862b-daaccdfb5c4f",
"ResourceId": "7bf1dc58-69c2-4bcc-b547-bb1e920bafce",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "9a81d230-28c5-48c9-9b8f-60344c2ae5c9",
"Type": 0,
"ResourceId": "1091f122-1dca-4dcc-8fbd-52870c86e714",
"Units": 3.0
},
{
"Id": "9a81d230-28c5-48c9-9b8f-60344c2ae5c9",
"Type": 0,
"ResourceId": "1091f122-1dca-4dcc-8fbd-52870c86e714",
"Units": 3.0
}
],
"ParentId": "71c20b21-87a4-4679-88df-268968b41a98",
"WorkTypeParentId": "a5f53a39-43e9-46f4-adc0-76d201b5bc50",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7f8f464d-463f-4a61-9042-b2416c27188d",
"UPN": "d4a99bb9-63f7-4273-816a-9c232e617038",
"PostDate": "2026-03-27T17:44:28.8775643+00:00",
"Comment": "sample string 4",
"CC": [
"48791392-bedd-492d-9f19-d5bec31b55ba",
"06d42fd4-e9b8-4749-939b-6b98ffa1f5fc"
],
"Users": [
"17ae63d5-3a35-4670-a5b2-14deff4306e3",
"e953949d-238f-4b8a-a5ad-9be46367c806"
]
},
{
"Id": "7f8f464d-463f-4a61-9042-b2416c27188d",
"UPN": "d4a99bb9-63f7-4273-816a-9c232e617038",
"PostDate": "2026-03-27T17:44:28.8775643+00:00",
"Comment": "sample string 4",
"CC": [
"48791392-bedd-492d-9f19-d5bec31b55ba",
"06d42fd4-e9b8-4749-939b-6b98ffa1f5fc"
],
"Users": [
"17ae63d5-3a35-4670-a5b2-14deff4306e3",
"e953949d-238f-4b8a-a5ad-9be46367c806"
]
}
],
"StartDate": "2026-03-27T17:44:28.8775643+00:00",
"DueDate": "2026-03-27T17:44:28.8775643+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"af585a07-7023-4f73-b8bb-a62287561cdc": "0149a2de-c75f-4dcc-9005-1843bceeac2f",
"f3024bf6-e389-43e7-8dea-dc9cbaefa708": "5ba5871e-feba-4f77-9b1f-de02cce43e64"
},
"HasUpdates": true,
"Modified": "2026-03-27T17:44:28.8775643+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-03-27T17:44:28.8775643+00:00"
},
"LastComment": "2026-03-27T17:44:28.8775643+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "824fb399-2cfe-4edb-88b9-51367f4af7fd",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "148bd7de-2f53-44df-bffc-6e7f176cdbb4",
"id": "c6006b36-ccbd-4b28-8210-e4996bb50f41",
"ConfigId": "62963627-4196-4e22-b745-caa05c9ad496"
}