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": "69b1817d-214d-4cb9-9284-0284af7cf185",
"ParentTaskId": "2dbd2900-4629-446b-8c8a-c838eda250d7",
"Integration": {
"IntegrationId": "f5b94640-0654-40b8-bd92-16eaab909de7",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"debe4804-22f4-4fe8-b28e-7e509db3a815": 2.0,
"a83c161c-f628-4fa0-a869-02a38effd1de": 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": "a4e19e62-b8aa-4a76-b7d7-13dfbe85e7ec",
"Name": "sample string 1",
"Created": "2026-10-03T21:32:45.2071593+00:00",
"Modified": "2026-10-03T21:32:45.2071593+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5cf6b9ef-7f0a-4632-b3d1-daeb7df499cf",
"0ac07275-7ec5-4249-9162-6f075971e359"
],
"NonLaborAssignments": [
{
"Id": "e45f6ef6-c742-4ebd-86b1-0a6b018ff47b",
"ResourceId": "a4631df3-1745-4468-9fb9-52ad9125c071",
"Quantity": 3.0
},
{
"Id": "e45f6ef6-c742-4ebd-86b1-0a6b018ff47b",
"ResourceId": "a4631df3-1745-4468-9fb9-52ad9125c071",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "2795f045-982b-4017-bb02-089ce9b8c454",
"Type": 0,
"ResourceId": "7710980d-36d8-4b90-a2b6-14dbac4adc1b",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "77e5ae64-c8d7-4800-b816-3e961e80b21d",
"Start": "2026-10-03T21:32:45.2071593+00:00",
"Due": "2026-10-03T21:32:45.2071593+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "77e5ae64-c8d7-4800-b816-3e961e80b21d",
"Start": "2026-10-03T21:32:45.2071593+00:00",
"Due": "2026-10-03T21:32:45.2071593+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "2795f045-982b-4017-bb02-089ce9b8c454",
"Type": 0,
"ResourceId": "7710980d-36d8-4b90-a2b6-14dbac4adc1b",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "77e5ae64-c8d7-4800-b816-3e961e80b21d",
"Start": "2026-10-03T21:32:45.2071593+00:00",
"Due": "2026-10-03T21:32:45.2071593+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "77e5ae64-c8d7-4800-b816-3e961e80b21d",
"Start": "2026-10-03T21:32:45.2071593+00:00",
"Due": "2026-10-03T21:32:45.2071593+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "e3ac0529-5ef7-4eaa-bf64-ab1286d338ee",
"WorkTypeParentId": "78dc5e7f-a6af-431f-93b7-d925a21376d6",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a2b1d72f-3d80-4233-b064-8f0a6237d6d5",
"UPN": "18346c7c-5d71-4a65-a252-bcc9fa0dc43b",
"PostDate": "2026-10-03T21:32:45.2071593+00:00",
"Comment": "sample string 4",
"CC": [
"b456e16f-93b4-40be-960f-313f1310ae8a",
"c1a0b67b-174e-402a-86ae-a21f151bfcd9"
],
"Users": [
"ea1317c7-f856-45da-a781-8014732b5028",
"4b233d57-7a91-4bff-9216-1cef3d3cc1c7"
]
},
{
"Id": "a2b1d72f-3d80-4233-b064-8f0a6237d6d5",
"UPN": "18346c7c-5d71-4a65-a252-bcc9fa0dc43b",
"PostDate": "2026-10-03T21:32:45.2071593+00:00",
"Comment": "sample string 4",
"CC": [
"b456e16f-93b4-40be-960f-313f1310ae8a",
"c1a0b67b-174e-402a-86ae-a21f151bfcd9"
],
"Users": [
"ea1317c7-f856-45da-a781-8014732b5028",
"4b233d57-7a91-4bff-9216-1cef3d3cc1c7"
]
}
],
"StartDate": "2026-10-03T21:32:45.2071593+00:00",
"DueDate": "2026-10-03T21:32:45.2071593+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"c20eb120-5779-4b96-98d7-806286581b7b": "c7b5bec9-55e8-4a8e-aaea-c04e61f75a5d",
"a89fd9a6-1b5d-4ceb-89f0-6b4856888d04": "2ad07cd9-bec1-44a2-aa2c-f09ea4d7f5c0"
},
"HasUpdates": true,
"Modified": "2026-10-03T21:32:45.2071593+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-03T21:32:45.2071593+00:00"
},
"LastComment": "2026-10-03T21:32:45.2071593+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "408a1f13-59e1-4125-b6e8-31a5d699d350",
"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": "9dcafae3-c3a6-4fc9-97f1-45ac6e95f571",
"id": "28fd27fd-4e8d-45d3-9940-e0d303d8e1e1",
"ConfigId": "92799e16-1a0b-48fa-9d03-c913cd7c1e15"
}