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": "2896d709-4d04-44e3-b012-3dc52fe639b0",
"ParentTaskId": "cb971cde-6981-4f21-9011-c4b8c4878c8b",
"Integration": {
"IntegrationId": "c2718086-662e-4a79-8600-0fecb7f9dfef",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2552eeba-30cf-4dd2-afed-dcacd2100dd8": 2.0,
"a336499c-dc70-463f-9969-0ab613021112": 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": "f2add75f-e20f-4508-a7f3-717271bd9062",
"Name": "sample string 1",
"Created": "2026-10-15T00:54:29.5892299+00:00",
"Modified": "2026-10-15T00:54:29.5892299+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"50aa26ff-fe5d-4057-a7d9-c1f2b04e7859",
"6aa28e04-0c45-4738-8a80-61592b0342af"
],
"NonLaborAssignments": [
{
"Id": "f8a556f6-3ab1-43f9-a93e-ad244956d885",
"ResourceId": "c8c834f2-a89a-4375-8923-d92cba51ecae",
"Quantity": 3.0
},
{
"Id": "f8a556f6-3ab1-43f9-a93e-ad244956d885",
"ResourceId": "c8c834f2-a89a-4375-8923-d92cba51ecae",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "906c400a-3c55-41c0-ba96-a3da86b95d3b",
"Type": 0,
"ResourceId": "509c7286-9cce-412d-b01d-e50944ab8275",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "47f26324-2071-4b97-8ac1-1ce0404e2306",
"Start": "2026-10-15T00:54:29.5892299+00:00",
"Due": "2026-10-15T00:54:29.5892299+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "47f26324-2071-4b97-8ac1-1ce0404e2306",
"Start": "2026-10-15T00:54:29.5892299+00:00",
"Due": "2026-10-15T00:54:29.5892299+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "906c400a-3c55-41c0-ba96-a3da86b95d3b",
"Type": 0,
"ResourceId": "509c7286-9cce-412d-b01d-e50944ab8275",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "47f26324-2071-4b97-8ac1-1ce0404e2306",
"Start": "2026-10-15T00:54:29.5892299+00:00",
"Due": "2026-10-15T00:54:29.5892299+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "47f26324-2071-4b97-8ac1-1ce0404e2306",
"Start": "2026-10-15T00:54:29.5892299+00:00",
"Due": "2026-10-15T00:54:29.5892299+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "e0211de2-1856-4dd5-8d3f-49795e39c2d6",
"WorkTypeParentId": "c559e166-f2e7-4c21-abcc-a9fd1e29262e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "acea53a3-5688-427b-a05d-e06946fda3af",
"UPN": "72d6bdda-6255-4da2-a1bd-84cf8d7418a5",
"PostDate": "2026-10-15T00:54:29.5892299+00:00",
"Comment": "sample string 4",
"CC": [
"dd023da1-6105-4ae2-ae30-1e5e1d052016",
"0389fa90-9b1b-470e-ab5d-d00ea4a8c77f"
],
"Users": [
"0be8d3b2-9399-4b6e-80c2-74d44782575f",
"61b6f7c6-83d3-405f-82f2-4bc153116705"
]
},
{
"Id": "acea53a3-5688-427b-a05d-e06946fda3af",
"UPN": "72d6bdda-6255-4da2-a1bd-84cf8d7418a5",
"PostDate": "2026-10-15T00:54:29.5892299+00:00",
"Comment": "sample string 4",
"CC": [
"dd023da1-6105-4ae2-ae30-1e5e1d052016",
"0389fa90-9b1b-470e-ab5d-d00ea4a8c77f"
],
"Users": [
"0be8d3b2-9399-4b6e-80c2-74d44782575f",
"61b6f7c6-83d3-405f-82f2-4bc153116705"
]
}
],
"StartDate": "2026-10-15T00:54:29.5892299+00:00",
"DueDate": "2026-10-15T00:54:29.5892299+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d9125992-5a16-43f1-8852-859d4df9279b": "044c8db5-1cb6-4730-9678-2e525e4b77e6",
"ba5fbc5b-c224-46eb-9980-b42aedf63bda": "639a18b3-eacb-4eca-b0b2-286f80d46594"
},
"HasUpdates": true,
"Modified": "2026-10-15T00:54:29.5892299+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-15T00:54:29.5892299+00:00"
},
"LastComment": "2026-10-15T00:54:29.5892299+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "45648576-1448-40c0-9234-8728a3db9cab",
"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": "b3e6bdb5-618f-4179-9b67-a6ca40d1a699",
"id": "73744038-15b9-487a-a243-0f648d0cf652",
"ConfigId": "6e17991f-3809-4c80-ab45-f2fdb8e3155b"
}