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": "ced1e590-7151-4a85-a2be-141a8e7972ec",
"ParentTaskId": "061c7e19-6c4e-4ade-b0ff-75b2a3bed3ee",
"Integration": {
"IntegrationId": "e16fbb39-80f2-4fea-9dc3-ccfad7dc78c5",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"56f02b6d-56f6-44b7-b846-7291e7443528": 2.0,
"206900cf-0af6-4b40-b548-902a13f4cfb1": 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": "aa9df00d-29c6-482e-914d-c4af4815411c",
"Name": "sample string 1",
"Created": "2026-06-30T08:59:29.3822843+00:00",
"Modified": "2026-06-30T08:59:29.3822843+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f402df5f-354f-4027-be3d-19f4a9668779",
"ecdf9f06-085a-47b3-bc3b-5e5a5d8ad0aa"
],
"NonLaborAssignments": [
{
"Id": "42312f6c-da78-46e1-b71d-5f46010ad0a9",
"ResourceId": "bb37a270-2a90-4f51-9dfd-dc733cdb921f",
"Quantity": 3.0
},
{
"Id": "42312f6c-da78-46e1-b71d-5f46010ad0a9",
"ResourceId": "bb37a270-2a90-4f51-9dfd-dc733cdb921f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1fcd044c-a40a-4d14-ac66-ee10c2f08c6d",
"Type": 0,
"ResourceId": "37c56c42-5854-4a39-b4ec-a28cec058bfe",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "1fcd044c-a40a-4d14-ac66-ee10c2f08c6d",
"Type": 0,
"ResourceId": "37c56c42-5854-4a39-b4ec-a28cec058bfe",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "cba2aa84-f180-423b-8f78-6c6f9d04cfb0",
"WorkTypeParentId": "aa579576-5cfa-4c89-a9e9-be3475dd957a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "dfa3aba9-0878-4527-b803-11c965f4b62c",
"UPN": "df341fc4-bfa1-4076-a8a6-da32a70fc106",
"PostDate": "2026-06-30T08:59:29.3822843+00:00",
"Comment": "sample string 4",
"CC": [
"6668f8ef-5b72-48d4-b9e3-aa8c102a40a2",
"2d202261-cd6f-4a26-bc02-8b3192512028"
],
"Users": [
"8090f3db-f3a0-4b08-af01-53f83762bbec",
"1dea102b-7869-406a-a495-e718734e7c99"
]
},
{
"Id": "dfa3aba9-0878-4527-b803-11c965f4b62c",
"UPN": "df341fc4-bfa1-4076-a8a6-da32a70fc106",
"PostDate": "2026-06-30T08:59:29.3822843+00:00",
"Comment": "sample string 4",
"CC": [
"6668f8ef-5b72-48d4-b9e3-aa8c102a40a2",
"2d202261-cd6f-4a26-bc02-8b3192512028"
],
"Users": [
"8090f3db-f3a0-4b08-af01-53f83762bbec",
"1dea102b-7869-406a-a495-e718734e7c99"
]
}
],
"StartDate": "2026-06-30T08:59:29.3822843+00:00",
"DueDate": "2026-06-30T08:59:29.3822843+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4044109e-0a47-43ee-9bfb-2e89851ab37c": "71febc15-26d3-4d31-af93-b24b7972e9a3",
"8a844c76-61fc-4679-ae09-765639b6759b": "7a6b4b90-6f62-4421-afa8-4baba9e6f063"
},
"HasUpdates": true,
"Modified": "2026-06-30T08:59:29.3822843+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-06-30T08:59:29.3822843+00:00"
},
"LastComment": "2026-06-30T08:59:29.3822843+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5e3be931-801c-4b9d-aacc-89d11f57a28c",
"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": "fa3e7ff2-2be9-43a6-b01f-87aa07145b6d",
"id": "c99e5490-4216-4dd9-9fe5-563d0e5db544",
"ConfigId": "c8c7bce6-0a4a-4f32-b7a7-bda5814b587a"
}