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": "a72b4b5a-b26d-4e44-ac0c-9b8b18edb8c4",
"ParentTaskId": "9faae7d4-b316-4af7-8f2e-fc39df1c4cfb",
"Integration": {
"IntegrationId": "c23fd8dd-c938-453b-8a97-fd217b36c2f9",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"08db7093-7252-4b1e-abf2-870f73fb0953": 2.0,
"8d7f2ed9-7046-4416-a9b3-b6e4a265d6a1": 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": "8b7b73ac-7c0f-4073-9548-887721098e2e",
"Name": "sample string 1",
"Created": "2026-10-17T20:22:10.9273984+00:00",
"Modified": "2026-10-17T20:22:10.9273984+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7026e945-9bb8-43a8-b88c-c990d69063e8",
"506fbd23-841d-4886-b941-7b817b013644"
],
"NonLaborAssignments": [
{
"Id": "3c0bc3c3-ca17-4696-a621-d9244fe7ef83",
"ResourceId": "349cb4b3-40e1-4c98-adc0-5de3f6356e42",
"Quantity": 3.0
},
{
"Id": "3c0bc3c3-ca17-4696-a621-d9244fe7ef83",
"ResourceId": "349cb4b3-40e1-4c98-adc0-5de3f6356e42",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "59cd867a-18d6-46f4-b384-48d3649a4693",
"Type": 0,
"ResourceId": "457b5235-5d75-4c95-817b-62f304c3e7f2",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "bb61ae13-afcd-4235-9a2a-28f1b93dc403",
"Start": "2026-10-17T20:22:10.9273984+00:00",
"Due": "2026-10-17T20:22:10.9273984+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "bb61ae13-afcd-4235-9a2a-28f1b93dc403",
"Start": "2026-10-17T20:22:10.9273984+00:00",
"Due": "2026-10-17T20:22:10.9273984+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "59cd867a-18d6-46f4-b384-48d3649a4693",
"Type": 0,
"ResourceId": "457b5235-5d75-4c95-817b-62f304c3e7f2",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "bb61ae13-afcd-4235-9a2a-28f1b93dc403",
"Start": "2026-10-17T20:22:10.9273984+00:00",
"Due": "2026-10-17T20:22:10.9273984+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "bb61ae13-afcd-4235-9a2a-28f1b93dc403",
"Start": "2026-10-17T20:22:10.9273984+00:00",
"Due": "2026-10-17T20:22:10.9273984+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "74a37fab-4204-480e-a727-046d1462a0d4",
"WorkTypeParentId": "a2651997-bec2-4b5a-ace1-d050de6ad45f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a80fc924-92d2-4b20-9a1c-3df7baa662a4",
"UPN": "cdcccfe8-e2b8-4ba7-9294-2be077654d18",
"PostDate": "2026-10-17T20:22:10.9273984+00:00",
"Comment": "sample string 4",
"CC": [
"cef4374a-75d9-4a80-9c2d-b5a5a4f7516d",
"287e5db3-5151-4751-95b5-b2e5e4c31f37"
],
"Users": [
"5a7329b2-e53f-440d-a402-d635c06353fa",
"21e5533b-43de-40aa-85fc-ba28363d7502"
]
},
{
"Id": "a80fc924-92d2-4b20-9a1c-3df7baa662a4",
"UPN": "cdcccfe8-e2b8-4ba7-9294-2be077654d18",
"PostDate": "2026-10-17T20:22:10.9273984+00:00",
"Comment": "sample string 4",
"CC": [
"cef4374a-75d9-4a80-9c2d-b5a5a4f7516d",
"287e5db3-5151-4751-95b5-b2e5e4c31f37"
],
"Users": [
"5a7329b2-e53f-440d-a402-d635c06353fa",
"21e5533b-43de-40aa-85fc-ba28363d7502"
]
}
],
"StartDate": "2026-10-17T20:22:10.9273984+00:00",
"DueDate": "2026-10-17T20:22:10.9273984+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"33505e58-1854-4c6f-988d-c00152fcb6e6": "75ea291c-bf3f-4f12-af02-29197f28ca61",
"8e0b6cdc-16ef-4110-87be-5e818b63c517": "51b0bb5d-c271-42a8-8a96-99baaf44396e"
},
"HasUpdates": true,
"Modified": "2026-10-17T20:22:10.9273984+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-17T20:22:10.9273984+00:00"
},
"LastComment": "2026-10-17T20:22:10.9273984+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f1f03083-956c-49e8-8493-8b6a32083781",
"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": "71048bb3-320c-40fb-b1ab-5062f1c9f465",
"id": "680e3d1e-5cf2-467a-9434-4f4449fad423",
"ConfigId": "55182f11-76d1-4535-9bc4-d0fac880e4b0"
}