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": "05b2d37a-2a12-421a-861e-681eb5d81dc7",
"ParentTaskId": "1144d586-d5e3-4923-bd7f-71ccff039cec",
"Integration": {
"IntegrationId": "1f1dd605-9b35-4904-ada2-d3617a690bc6",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"939234be-bee9-4004-8d92-e7b69af4df19": 2.0,
"006d6a04-9a9f-4cc1-9c16-cd254bab0313": 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": "1bd3178b-8606-415b-bff6-763350c91d84",
"Name": "sample string 1",
"Created": "2026-07-11T22:40:55.8418419+00:00",
"Modified": "2026-07-11T22:40:55.8418419+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0038a6da-dc1d-442a-9751-1fa9ae0c4631",
"96972fd1-9f33-412b-bbd5-7a1120fc161c"
],
"NonLaborAssignments": [
{
"Id": "e07ab496-d36a-4258-b92d-8a7a5161658b",
"ResourceId": "db696e4d-1e3a-4176-825d-22c44c9512e9",
"Quantity": 3.0
},
{
"Id": "e07ab496-d36a-4258-b92d-8a7a5161658b",
"ResourceId": "db696e4d-1e3a-4176-825d-22c44c9512e9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "69877753-46bf-46e8-a9bd-e7fbdce1f4f4",
"Type": 0,
"ResourceId": "86e81838-8a7f-45b8-9cd8-61291044a2df",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "69877753-46bf-46e8-a9bd-e7fbdce1f4f4",
"Type": 0,
"ResourceId": "86e81838-8a7f-45b8-9cd8-61291044a2df",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "122e78f4-4208-45d9-87e0-72ed0a99ee25",
"WorkTypeParentId": "f81aa1bc-65d4-4ea8-a2e7-59bbe85bb232",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e9776bfe-b415-4df1-aacf-daddc4bf034e",
"UPN": "9cbbb849-3d20-41e8-92d4-3bfe31421584",
"PostDate": "2026-07-11T22:40:55.8418419+00:00",
"Comment": "sample string 4",
"CC": [
"b08c5db4-fcb9-4151-80ff-f37c61a65f0b",
"6ec908c6-e838-49b8-96cf-283ef03ab302"
],
"Users": [
"c032b9ad-1070-473d-90f7-a237fa8dbc7a",
"0c26f5b9-02b8-4cfe-a5dd-84b78f57fb13"
]
},
{
"Id": "e9776bfe-b415-4df1-aacf-daddc4bf034e",
"UPN": "9cbbb849-3d20-41e8-92d4-3bfe31421584",
"PostDate": "2026-07-11T22:40:55.8418419+00:00",
"Comment": "sample string 4",
"CC": [
"b08c5db4-fcb9-4151-80ff-f37c61a65f0b",
"6ec908c6-e838-49b8-96cf-283ef03ab302"
],
"Users": [
"c032b9ad-1070-473d-90f7-a237fa8dbc7a",
"0c26f5b9-02b8-4cfe-a5dd-84b78f57fb13"
]
}
],
"StartDate": "2026-07-11T22:40:55.8418419+00:00",
"DueDate": "2026-07-11T22:40:55.8418419+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d2488c49-c3d2-46d3-aefb-0d6864f3532e": "7f5d5d1d-bfcb-4fde-84ce-b3fdd76cd966",
"22426e8a-45f2-4e70-8873-db377352cd36": "79cbe0a7-9bf1-478a-bd4b-ff3f31f67c29"
},
"HasUpdates": true,
"Modified": "2026-07-11T22:40:55.8418419+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-07-11T22:40:55.857466+00:00"
},
"LastComment": "2026-07-11T22:40:55.857466+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "dbd5782d-cc1f-4eaf-a8a0-9c3f0e1f0201",
"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": "05f50d2d-c87b-4ca3-82d7-4407fe280d51",
"id": "9e00d882-0de0-45aa-a620-cfb3c56fefbb",
"ConfigId": "0590077a-96f4-4565-b1b0-9661822fc1bf"
}