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": "cd1dc9ba-a2a2-43a3-a260-fd854ef9e3ef",
"ParentTaskId": "f48b48fc-277a-4e40-816c-4d0ea0e95164",
"Integration": {
"IntegrationId": "01e91892-2f73-4241-9431-e52864b74937",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c827bd97-77be-4051-97da-66a48b445dd3": 2.0,
"a67818f6-d3c2-4a8b-9a6b-ed0a33c05c6d": 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": "5c5d04da-44f1-473b-8590-e80a712b5cc1",
"Name": "sample string 1",
"Created": "2026-10-09T01:28:12.2048601+00:00",
"Modified": "2026-10-09T01:28:12.2048601+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2dac85a4-2c96-4cac-81aa-9881189ac238",
"faac2543-ebea-4c53-a900-431c9ea46637"
],
"NonLaborAssignments": [
{
"Id": "e7779eec-6785-4c91-9368-3303a3c7a7c8",
"ResourceId": "dbf1ee15-8df9-4385-9266-7651036f34c4",
"Quantity": 3.0
},
{
"Id": "e7779eec-6785-4c91-9368-3303a3c7a7c8",
"ResourceId": "dbf1ee15-8df9-4385-9266-7651036f34c4",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "57995b6a-a5ae-4eeb-b51a-af9b7eef46c8",
"Type": 0,
"ResourceId": "75408491-68b8-4307-ae6b-d99df29b8f15",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7971ec8c-a166-41c9-bb99-3d47ad3686a0",
"Start": "2026-10-09T01:28:12.2048601+00:00",
"Due": "2026-10-09T01:28:12.2204862+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7971ec8c-a166-41c9-bb99-3d47ad3686a0",
"Start": "2026-10-09T01:28:12.2048601+00:00",
"Due": "2026-10-09T01:28:12.2204862+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "57995b6a-a5ae-4eeb-b51a-af9b7eef46c8",
"Type": 0,
"ResourceId": "75408491-68b8-4307-ae6b-d99df29b8f15",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7971ec8c-a166-41c9-bb99-3d47ad3686a0",
"Start": "2026-10-09T01:28:12.2048601+00:00",
"Due": "2026-10-09T01:28:12.2204862+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7971ec8c-a166-41c9-bb99-3d47ad3686a0",
"Start": "2026-10-09T01:28:12.2048601+00:00",
"Due": "2026-10-09T01:28:12.2204862+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "ff370ccb-6a43-4059-bf22-0518257fe009",
"WorkTypeParentId": "88286f42-c82a-4a2d-94a9-2ce609a81507",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "96e4c63b-072f-4c1b-bf20-766d6aafee0a",
"UPN": "6f3fa446-0a11-4913-8da8-03cd0d17924c",
"PostDate": "2026-10-09T01:28:12.2204862+00:00",
"Comment": "sample string 4",
"CC": [
"7560bb04-0094-43f4-b185-4a037d42aec6",
"46589357-b417-4c87-b639-e584c8c885cc"
],
"Users": [
"4a1a49ad-0e9b-467e-b826-8c96d0a8a00d",
"d2739474-05a3-4cdb-b068-22546a5057c2"
]
},
{
"Id": "96e4c63b-072f-4c1b-bf20-766d6aafee0a",
"UPN": "6f3fa446-0a11-4913-8da8-03cd0d17924c",
"PostDate": "2026-10-09T01:28:12.2204862+00:00",
"Comment": "sample string 4",
"CC": [
"7560bb04-0094-43f4-b185-4a037d42aec6",
"46589357-b417-4c87-b639-e584c8c885cc"
],
"Users": [
"4a1a49ad-0e9b-467e-b826-8c96d0a8a00d",
"d2739474-05a3-4cdb-b068-22546a5057c2"
]
}
],
"StartDate": "2026-10-09T01:28:12.2204862+00:00",
"DueDate": "2026-10-09T01:28:12.2204862+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"68c8fa56-0eb5-4e3c-ba09-4133ce87aaa9": "450bdcde-538e-494d-80bc-0ae398c3952a",
"902fa965-f6b1-4f70-95ee-f87e4ad07351": "ffc6515c-9c39-4330-8023-f215080b2310"
},
"HasUpdates": true,
"Modified": "2026-10-09T01:28:12.2204862+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-09T01:28:12.2204862+00:00"
},
"LastComment": "2026-10-09T01:28:12.2204862+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3596d0c0-bb4a-462d-b0ef-66dc26618fe4",
"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": "d075a0f0-6d26-46fc-949e-59de1a0dab5e",
"id": "9ab57824-914e-4864-bf61-54b4b2d98c85",
"ConfigId": "a8513dee-30fa-4e85-957a-9400095898a3"
}