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": "1d0b0ce4-3a9d-4050-a98c-068ae3a9bab9",
"ParentTaskId": "3689f7e3-ae44-4ba7-b6e2-d3417d037f6b",
"Integration": {
"IntegrationId": "a532a853-5e7f-4c67-8f5a-cac59fb7066e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"fc662c48-ce41-43c6-a349-5c7a11a81b5b": 2.0,
"0fea0754-773f-427c-942e-6b01ed258423": 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": "3b88457a-1117-4051-947a-f114149893c5",
"Name": "sample string 1",
"Created": "2026-10-04T14:44:13.652453+00:00",
"Modified": "2026-10-04T14:44:13.652453+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"bae61378-a001-4f83-bc65-b8396ee8c7e6",
"d19c3f10-0de5-4ade-9e96-5f4ce7505945"
],
"NonLaborAssignments": [
{
"Id": "9b741fa3-b652-448d-a563-3941edc0a11d",
"ResourceId": "eb1506d8-ce32-44fd-9df1-6d0ddc46b426",
"Quantity": 3.0
},
{
"Id": "9b741fa3-b652-448d-a563-3941edc0a11d",
"ResourceId": "eb1506d8-ce32-44fd-9df1-6d0ddc46b426",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "0dea3529-a954-499c-910a-22a701a37ee4",
"Type": 0,
"ResourceId": "89a4f2db-3dde-4e0b-ad8f-63cb41d04454",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "03f0be87-1fcb-4dd1-8716-c775111d3fbf",
"Start": "2026-10-04T14:44:13.652453+00:00",
"Due": "2026-10-04T14:44:13.652453+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "03f0be87-1fcb-4dd1-8716-c775111d3fbf",
"Start": "2026-10-04T14:44:13.652453+00:00",
"Due": "2026-10-04T14:44:13.652453+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "0dea3529-a954-499c-910a-22a701a37ee4",
"Type": 0,
"ResourceId": "89a4f2db-3dde-4e0b-ad8f-63cb41d04454",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "03f0be87-1fcb-4dd1-8716-c775111d3fbf",
"Start": "2026-10-04T14:44:13.652453+00:00",
"Due": "2026-10-04T14:44:13.652453+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "03f0be87-1fcb-4dd1-8716-c775111d3fbf",
"Start": "2026-10-04T14:44:13.652453+00:00",
"Due": "2026-10-04T14:44:13.652453+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "f7dbb3ec-b4d5-42dd-bc14-e12e3411ad09",
"WorkTypeParentId": "05c51fdf-43cf-4e57-be1f-47b9fb45896e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "38edfd28-4d31-4e10-b246-7261e42bf3a3",
"UPN": "9906edea-c64f-4b3e-bcf6-92b05c19654b",
"PostDate": "2026-10-04T14:44:13.652453+00:00",
"Comment": "sample string 4",
"CC": [
"7e260e2a-2a7c-4a05-9e02-d8010cea2ec3",
"4aba6acb-b9e3-4101-a5b9-57105900ba71"
],
"Users": [
"39339c65-8061-465f-86a4-5dbd74c852d4",
"6b653b01-e5b3-4f61-bb48-2c020cd38f6d"
]
},
{
"Id": "38edfd28-4d31-4e10-b246-7261e42bf3a3",
"UPN": "9906edea-c64f-4b3e-bcf6-92b05c19654b",
"PostDate": "2026-10-04T14:44:13.652453+00:00",
"Comment": "sample string 4",
"CC": [
"7e260e2a-2a7c-4a05-9e02-d8010cea2ec3",
"4aba6acb-b9e3-4101-a5b9-57105900ba71"
],
"Users": [
"39339c65-8061-465f-86a4-5dbd74c852d4",
"6b653b01-e5b3-4f61-bb48-2c020cd38f6d"
]
}
],
"StartDate": "2026-10-04T14:44:13.652453+00:00",
"DueDate": "2026-10-04T14:44:13.652453+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4a61f9f8-01ae-4450-9b2a-4ffd2c27390f": "f0ec6d20-cbd8-4c84-a217-918fbd80b476",
"639cee45-83ab-474d-89ed-cf604dc5c3f7": "41683598-4e00-49b3-9e2e-2734e4f17da2"
},
"HasUpdates": true,
"Modified": "2026-10-04T14:44:13.652453+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-04T14:44:13.652453+00:00"
},
"LastComment": "2026-10-04T14:44:13.652453+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c905da42-f290-4668-8dd3-b1ecd12bde9e",
"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": "c84317b6-9e95-4ab3-865f-9278560e7137",
"id": "c008db12-174d-4851-9a2a-48c87c182e4c",
"ConfigId": "20f256ff-64f4-4a1c-99e1-549085c309c5"
}