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": "2f5a4f56-08a7-4daa-9d90-8a69e1d46462",
"ParentTaskId": "a3a562a8-c646-4849-9563-e89072b627bd",
"Integration": {
"IntegrationId": "159dc312-b1f5-4aa2-a7bd-9d16d1087ff6",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"451b11fe-eef6-440f-8dc6-5ff91d2160c7": 2.0,
"715fd2b6-ce8c-4cad-916e-452ef540475e": 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": "2dd465a6-3e25-40b1-988f-83a604e79eb3",
"Name": "sample string 1",
"Created": "2026-06-10T22:58:51.974912+00:00",
"Modified": "2026-06-10T22:58:51.974912+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"512e6e0f-ee96-4616-a7e0-1ac8017d1735",
"640fe246-1bbd-44cd-bfd5-19d89100e9cc"
],
"NonLaborAssignments": [
{
"Id": "bcdd2244-51d1-4924-8a10-bd8b171b5c36",
"ResourceId": "1d7a2592-c760-44d3-a799-16c032345b47",
"Quantity": 3.0
},
{
"Id": "bcdd2244-51d1-4924-8a10-bd8b171b5c36",
"ResourceId": "1d7a2592-c760-44d3-a799-16c032345b47",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "916ee6d8-505e-4e68-950f-c82c035b11c4",
"Type": 0,
"ResourceId": "92b2bd7a-abbc-41a5-ace0-ca22e793994f",
"Units": 3.0
},
{
"Id": "916ee6d8-505e-4e68-950f-c82c035b11c4",
"Type": 0,
"ResourceId": "92b2bd7a-abbc-41a5-ace0-ca22e793994f",
"Units": 3.0
}
],
"ParentId": "8c199849-a158-4cf4-8503-60909772d364",
"WorkTypeParentId": "73e3c533-21fc-48f2-8887-887ea414427c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "40229151-f8b2-40a7-951a-f6283e613960",
"UPN": "4d1a4d08-7e62-4231-a2bb-fff2f003e444",
"PostDate": "2026-06-10T22:58:51.974912+00:00",
"Comment": "sample string 4",
"CC": [
"9652911b-7dfa-4d83-ae8f-74f46a1fb05d",
"7b756980-4886-48b2-afce-6c11c18c3e12"
],
"Users": [
"825e244a-0d64-467a-9557-06d99b4a7e21",
"6ba9c1b0-b7f1-4a30-a0ce-9cbf2bdb7c1e"
]
},
{
"Id": "40229151-f8b2-40a7-951a-f6283e613960",
"UPN": "4d1a4d08-7e62-4231-a2bb-fff2f003e444",
"PostDate": "2026-06-10T22:58:51.974912+00:00",
"Comment": "sample string 4",
"CC": [
"9652911b-7dfa-4d83-ae8f-74f46a1fb05d",
"7b756980-4886-48b2-afce-6c11c18c3e12"
],
"Users": [
"825e244a-0d64-467a-9557-06d99b4a7e21",
"6ba9c1b0-b7f1-4a30-a0ce-9cbf2bdb7c1e"
]
}
],
"StartDate": "2026-06-10T22:58:51.974912+00:00",
"DueDate": "2026-06-10T22:58:51.974912+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1c7f9599-5582-4a6e-ab92-d95a23b892df": "be2140e7-eb36-4f51-b701-3220efa3c9ed",
"ab85621d-35a2-4465-b50d-e5d99821b33a": "91ff0102-d9b3-4c34-b1bf-0ac70b4d9619"
},
"HasUpdates": true,
"Modified": "2026-06-10T22:58:51.974912+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-10T22:58:51.974912+00:00"
},
"LastComment": "2026-06-10T22:58:51.974912+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f24302da-33eb-4125-b7fe-5c35162478c3",
"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": "f0a6f99a-0b98-4cc0-aed9-69b6fe3ec8c7",
"id": "a1a2b8b3-68bb-4275-8bba-e50572ba3131",
"ConfigId": "aca7a331-78b4-4061-b7b2-2a38912b09f8"
}