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": "0f7708a6-973c-4c28-bac5-b89869cb6136",
"ParentTaskId": "fbe97878-b9da-4cf2-bb03-892b7d672085",
"Integration": {
"IntegrationId": "61b75e08-bb19-49a9-9d3e-4e28b7a6dd29",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"97c5ee80-368b-46d6-beaa-8b1d28bbcbdf": 2.0,
"8a2da465-f5c9-4c76-bd9f-183236cde550": 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": "68c01a8f-e2f1-4464-b8db-3c2d2ae76af1",
"Name": "sample string 1",
"Created": "2026-10-18T09:02:52.4590449+00:00",
"Modified": "2026-10-18T09:02:52.4590449+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"bc631f29-c87b-4f07-a963-cbe65fab37b0",
"be370441-2efe-4672-9ad3-78741a39912f"
],
"NonLaborAssignments": [
{
"Id": "ba23ecac-865b-416b-a858-eb0f20e6b2ff",
"ResourceId": "31de1bdf-86cb-478a-a755-5d0bec7a8ca6",
"Quantity": 3.0
},
{
"Id": "ba23ecac-865b-416b-a858-eb0f20e6b2ff",
"ResourceId": "31de1bdf-86cb-478a-a755-5d0bec7a8ca6",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "673375ed-65e4-4344-a929-3369ba348a22",
"Type": 0,
"ResourceId": "88a8931b-33d4-4dd4-8e0b-ae238a30f794",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "aadf8329-437b-4b7d-b766-c59aba248acf",
"Start": "2026-10-18T09:02:52.4590449+00:00",
"Due": "2026-10-18T09:02:52.4590449+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "aadf8329-437b-4b7d-b766-c59aba248acf",
"Start": "2026-10-18T09:02:52.4590449+00:00",
"Due": "2026-10-18T09:02:52.4590449+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "673375ed-65e4-4344-a929-3369ba348a22",
"Type": 0,
"ResourceId": "88a8931b-33d4-4dd4-8e0b-ae238a30f794",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "aadf8329-437b-4b7d-b766-c59aba248acf",
"Start": "2026-10-18T09:02:52.4590449+00:00",
"Due": "2026-10-18T09:02:52.4590449+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "aadf8329-437b-4b7d-b766-c59aba248acf",
"Start": "2026-10-18T09:02:52.4590449+00:00",
"Due": "2026-10-18T09:02:52.4590449+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "0fa60ad5-e3af-4976-9029-24b4d111d282",
"WorkTypeParentId": "edacff83-c256-4bce-920e-9a19603e22a4",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "cec84541-b56d-4d4d-aa13-f4cfd02fd03b",
"UPN": "524c6090-63ba-4cfd-bc8e-ed5580fafc95",
"PostDate": "2026-10-18T09:02:52.4590449+00:00",
"Comment": "sample string 4",
"CC": [
"056f8f46-d6e1-460c-b031-cc0cb3ca9bd8",
"4ea1d3a1-e320-4735-a154-93fa48093d33"
],
"Users": [
"820bdd24-28b1-4f8d-911c-9f665c158966",
"4e7b7a60-7d84-49a8-a9a1-a43ba573e8b9"
]
},
{
"Id": "cec84541-b56d-4d4d-aa13-f4cfd02fd03b",
"UPN": "524c6090-63ba-4cfd-bc8e-ed5580fafc95",
"PostDate": "2026-10-18T09:02:52.4590449+00:00",
"Comment": "sample string 4",
"CC": [
"056f8f46-d6e1-460c-b031-cc0cb3ca9bd8",
"4ea1d3a1-e320-4735-a154-93fa48093d33"
],
"Users": [
"820bdd24-28b1-4f8d-911c-9f665c158966",
"4e7b7a60-7d84-49a8-a9a1-a43ba573e8b9"
]
}
],
"StartDate": "2026-10-18T09:02:52.4590449+00:00",
"DueDate": "2026-10-18T09:02:52.4590449+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"2d92a3b3-27a5-4cc2-9dab-f363aa484469": "8044d5eb-fa31-4e40-80f6-7209d01653d3",
"2f3903a2-7719-4b12-9515-d8175d7ea4e0": "bcd2a6de-c3d2-49c0-b1c7-f6a140fd8b46"
},
"HasUpdates": true,
"Modified": "2026-10-18T09:02:52.4590449+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-18T09:02:52.4590449+00:00"
},
"LastComment": "2026-10-18T09:02:52.4590449+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a0a58ba3-4506-4ba4-a0eb-47fb212ff026",
"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": "7dc3b85e-d281-4287-b305-f4192d8d86a6",
"id": "948192d5-3cae-4df3-bbfb-f02f670f0328",
"ConfigId": "b0dd9cb2-1cf3-42a2-88c9-82e6e405de71"
}