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": "3e1d0db3-be58-4fb7-a1cc-d553b33ad00f",
"ParentTaskId": "aa8da13a-1c06-4726-8496-df87bd7310a3",
"Integration": {
"IntegrationId": "9dc90803-5916-4b1f-a6a2-f9264bef4595",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f80434c8-e11a-4123-b6f3-c12628afe23e": 2.0,
"d924f7b5-226e-41ac-8402-12517c07e05e": 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": "1f315f52-8a26-41b0-ad3e-e3c13a7b205a",
"Name": "sample string 1",
"Created": "2026-06-03T16:03:06.3929659+00:00",
"Modified": "2026-06-03T16:03:06.3929659+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"22ebcd9c-dc01-4860-a1ba-bd186ffbf4b5",
"c899ccf7-8f95-4040-8629-7ee9534c670e"
],
"NonLaborAssignments": [
{
"Id": "018dc3d7-4518-4c16-9de4-878d9ff6ec63",
"ResourceId": "f574cfa8-e9aa-4306-b4d6-2c7812149233",
"Quantity": 3.0
},
{
"Id": "018dc3d7-4518-4c16-9de4-878d9ff6ec63",
"ResourceId": "f574cfa8-e9aa-4306-b4d6-2c7812149233",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "50062103-4b8b-4ce3-8c36-99f8fe431664",
"Type": 0,
"ResourceId": "5fd795f4-3008-439e-9b3b-03a7047296b1",
"Units": 3.0
},
{
"Id": "50062103-4b8b-4ce3-8c36-99f8fe431664",
"Type": 0,
"ResourceId": "5fd795f4-3008-439e-9b3b-03a7047296b1",
"Units": 3.0
}
],
"ParentId": "55c522dc-09cd-422e-9f13-eb35004d8e4f",
"WorkTypeParentId": "e3d63346-a931-4e53-af46-9aa13af92fca",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "96e9b5f0-f0e7-4e1a-9ab9-58506e62ef9f",
"UPN": "0b0e1f02-801e-4a8d-b9b2-9e5f36d7e703",
"PostDate": "2026-06-03T16:03:06.3929659+00:00",
"Comment": "sample string 4",
"CC": [
"9da7311d-ad30-43c2-bf58-df1fb5d96a31",
"3257b015-1db0-4824-a80e-b6eeb806c900"
],
"Users": [
"ea36526b-b967-4cca-8263-227d81c17069",
"002817c4-d022-4f8b-b322-f25c26e1447f"
]
},
{
"Id": "96e9b5f0-f0e7-4e1a-9ab9-58506e62ef9f",
"UPN": "0b0e1f02-801e-4a8d-b9b2-9e5f36d7e703",
"PostDate": "2026-06-03T16:03:06.3929659+00:00",
"Comment": "sample string 4",
"CC": [
"9da7311d-ad30-43c2-bf58-df1fb5d96a31",
"3257b015-1db0-4824-a80e-b6eeb806c900"
],
"Users": [
"ea36526b-b967-4cca-8263-227d81c17069",
"002817c4-d022-4f8b-b322-f25c26e1447f"
]
}
],
"StartDate": "2026-06-03T16:03:06.3929659+00:00",
"DueDate": "2026-06-03T16:03:06.3929659+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"de331d71-dd58-45e5-aa67-cf7c7d78288b": "0c995fcc-98f1-4592-9ea1-5cc9a08605da",
"78f69830-5a1f-416c-a6c5-64ade1231942": "16e3d4d9-a074-4521-9c1f-b7d72d01a771"
},
"HasUpdates": true,
"Modified": "2026-06-03T16:03:06.3929659+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-03T16:03:06.3929659+00:00"
},
"LastComment": "2026-06-03T16:03:06.3929659+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "8cf4efff-92b0-4f3d-a2a4-8ed01a9820f8",
"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": "e1c16ec5-4f26-4541-8c86-fdc37e05eb52",
"id": "c6f022f4-422d-46da-bfe1-8ec450264846",
"ConfigId": "d0dea453-985e-4126-9e0e-24de64557e64"
}