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": "f8626a84-7fb0-40c2-bc40-6f823a5916f4",
"ParentTaskId": "1ca4584f-c4ec-433f-96d2-03c069e4f358",
"Integration": {
"IntegrationId": "cbc2a05a-3e68-4fb1-9b88-15d01fc9704c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"7e8ad3c1-5b39-4264-9334-4d80c15eb560": 2.0,
"69682c79-c0b1-4eda-872b-577eae4db24f": 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": "15b3da06-e41a-4de6-8023-81533a9c6f6f",
"Name": "sample string 1",
"Created": "2026-10-13T11:39:05.2881218+00:00",
"Modified": "2026-10-13T11:39:05.2881218+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"79420ef3-eae1-46cc-987d-97e757251976",
"d7439918-3372-4d99-b8bb-1f551fb37adb"
],
"NonLaborAssignments": [
{
"Id": "df7298cf-0de7-45a1-8142-62393d6fee9f",
"ResourceId": "c9bd23d0-5429-4dca-92c8-86c877de85f0",
"Quantity": 3.0
},
{
"Id": "df7298cf-0de7-45a1-8142-62393d6fee9f",
"ResourceId": "c9bd23d0-5429-4dca-92c8-86c877de85f0",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "af8b3683-97b3-46da-8bf4-721c1154f1ce",
"Type": 0,
"ResourceId": "52da3eee-1891-439c-9397-e49f579443f2",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6cdd845b-6783-46e9-83f5-97b52bb72330",
"Start": "2026-10-13T11:39:05.2881218+00:00",
"Due": "2026-10-13T11:39:05.2881218+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6cdd845b-6783-46e9-83f5-97b52bb72330",
"Start": "2026-10-13T11:39:05.2881218+00:00",
"Due": "2026-10-13T11:39:05.2881218+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "af8b3683-97b3-46da-8bf4-721c1154f1ce",
"Type": 0,
"ResourceId": "52da3eee-1891-439c-9397-e49f579443f2",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6cdd845b-6783-46e9-83f5-97b52bb72330",
"Start": "2026-10-13T11:39:05.2881218+00:00",
"Due": "2026-10-13T11:39:05.2881218+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6cdd845b-6783-46e9-83f5-97b52bb72330",
"Start": "2026-10-13T11:39:05.2881218+00:00",
"Due": "2026-10-13T11:39:05.2881218+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "e1fe07bb-0f37-4d00-8287-46fc41c4dd7c",
"WorkTypeParentId": "b91885a4-7b39-414e-a69d-18db9fb39615",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "5b330096-f39c-4944-8161-cf765ada071e",
"UPN": "dd3df1fd-7c84-4c9d-86d4-421baebcb45d",
"PostDate": "2026-10-13T11:39:05.2881218+00:00",
"Comment": "sample string 4",
"CC": [
"493af064-4932-443b-8098-d93527406a7e",
"616266bd-620b-4129-87d5-a17e7efd6d5d"
],
"Users": [
"8ec14ddf-9b9a-4b46-9720-7613ed404e25",
"56085bec-1d97-4a91-9d1e-b9bd40ef1f72"
]
},
{
"Id": "5b330096-f39c-4944-8161-cf765ada071e",
"UPN": "dd3df1fd-7c84-4c9d-86d4-421baebcb45d",
"PostDate": "2026-10-13T11:39:05.2881218+00:00",
"Comment": "sample string 4",
"CC": [
"493af064-4932-443b-8098-d93527406a7e",
"616266bd-620b-4129-87d5-a17e7efd6d5d"
],
"Users": [
"8ec14ddf-9b9a-4b46-9720-7613ed404e25",
"56085bec-1d97-4a91-9d1e-b9bd40ef1f72"
]
}
],
"StartDate": "2026-10-13T11:39:05.2881218+00:00",
"DueDate": "2026-10-13T11:39:05.2881218+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"cfa121a1-aeec-4c41-9afb-86bccd3823df": "40e92900-f3bf-4f79-9a8d-e3fac9bd98af",
"73d108ae-d930-4133-b2ed-0e5999d6d7a7": "ea323a30-2c77-4d56-a5e5-4ca9bc68edff"
},
"HasUpdates": true,
"Modified": "2026-10-13T11:39:05.2881218+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-13T11:39:05.2881218+00:00"
},
"LastComment": "2026-10-13T11:39:05.2881218+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ec80852a-588b-4f23-a458-fcfdd14e72f3",
"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": "c1e5b46b-43b5-419e-9d38-0e73fe825de7",
"id": "ce9d2f4b-5d4f-4449-a151-e74fbe97a0fc",
"ConfigId": "5c8d0a4a-3126-43ea-b423-b6245635c890"
}