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": "3f98ea7f-0e00-42e4-abb4-9c1815fddacd",
"ParentTaskId": "fa3338de-0165-4238-809d-b90f7d53b35a",
"Integration": {
"IntegrationId": "60f73a3d-4c93-4160-9931-10720fa68a59",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"91827f43-649c-4e5a-96d8-f3e8cdd16c0d": 2.0,
"f5bed52e-1da5-48c3-96d4-7b8938e824d0": 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": "77dce2c7-6bc9-40c5-99a2-f06e00024f54",
"Name": "sample string 1",
"Created": "2026-10-24T07:19:56.0294463+00:00",
"Modified": "2026-10-24T07:19:56.0294463+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"098c20c5-fbcf-45dc-a7d0-5ad25176a0b0",
"8cdf68e4-d3b7-47b0-b387-09b7aefa05ec"
],
"NonLaborAssignments": [
{
"Id": "83297ce8-1cc7-4433-8173-474a718a7b9a",
"ResourceId": "4b35cf3f-03c6-450e-8906-f02539e11464",
"Quantity": 3.0
},
{
"Id": "83297ce8-1cc7-4433-8173-474a718a7b9a",
"ResourceId": "4b35cf3f-03c6-450e-8906-f02539e11464",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "02d8fad8-a3d9-4545-aa99-1e9a164ceda5",
"Type": 0,
"ResourceId": "189be6cf-3e21-4598-9e2e-fec7aa2a48c7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "bcae57dc-ff0a-4c0b-a991-762782cfff6f",
"Start": "2026-10-24T07:19:56.0294463+00:00",
"Due": "2026-10-24T07:19:56.0294463+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "bcae57dc-ff0a-4c0b-a991-762782cfff6f",
"Start": "2026-10-24T07:19:56.0294463+00:00",
"Due": "2026-10-24T07:19:56.0294463+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "02d8fad8-a3d9-4545-aa99-1e9a164ceda5",
"Type": 0,
"ResourceId": "189be6cf-3e21-4598-9e2e-fec7aa2a48c7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "bcae57dc-ff0a-4c0b-a991-762782cfff6f",
"Start": "2026-10-24T07:19:56.0294463+00:00",
"Due": "2026-10-24T07:19:56.0294463+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "bcae57dc-ff0a-4c0b-a991-762782cfff6f",
"Start": "2026-10-24T07:19:56.0294463+00:00",
"Due": "2026-10-24T07:19:56.0294463+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "106eee26-98c2-4ad6-819a-221b5b55ca4f",
"WorkTypeParentId": "ebfd12ec-6624-4711-8531-945aabf29c8b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "af4b4eb9-bbdf-4e10-a4a5-cc1fe7b96fc8",
"UPN": "0e27a6df-df3b-4046-8818-89a2f07289f6",
"PostDate": "2026-10-24T07:19:56.0294463+00:00",
"Comment": "sample string 4",
"CC": [
"792f58f6-0c87-4cdc-8073-ac46720b76bb",
"f2dcbd63-43f6-4afc-aa65-907ea6bbd701"
],
"Users": [
"44c536d3-b71a-49ed-b3b6-11d11f74c2c7",
"5fd5065a-8106-4799-b01a-0a9d302faee1"
]
},
{
"Id": "af4b4eb9-bbdf-4e10-a4a5-cc1fe7b96fc8",
"UPN": "0e27a6df-df3b-4046-8818-89a2f07289f6",
"PostDate": "2026-10-24T07:19:56.0294463+00:00",
"Comment": "sample string 4",
"CC": [
"792f58f6-0c87-4cdc-8073-ac46720b76bb",
"f2dcbd63-43f6-4afc-aa65-907ea6bbd701"
],
"Users": [
"44c536d3-b71a-49ed-b3b6-11d11f74c2c7",
"5fd5065a-8106-4799-b01a-0a9d302faee1"
]
}
],
"StartDate": "2026-10-24T07:19:56.0294463+00:00",
"DueDate": "2026-10-24T07:19:56.0294463+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e4d7baf1-a92a-4d5e-ab05-0695ee015e95": "49cb1377-2bfd-4864-98ab-497c3754f8b3",
"de04049b-1ec8-46c5-8e4a-f25038c15197": "2a6e5727-2b2e-4d5c-8635-98a9bf43c6d0"
},
"HasUpdates": true,
"Modified": "2026-10-24T07:19:56.0294463+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-24T07:19:56.0294463+00:00"
},
"LastComment": "2026-10-24T07:19:56.0294463+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f6dd4585-40aa-4ab2-bcbd-56f5f12c7e8f",
"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": "51150e1a-407b-4500-91fe-163b15c06fd1",
"id": "55b736f4-2833-45c5-9f1b-08a687454b68",
"ConfigId": "a2792ccd-7bcc-4fa2-a72e-50d1cde2af24"
}