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": "dc174cfc-9bbe-452f-a238-5a43957240fa",
"ParentTaskId": "9ecd8e2d-5daf-448b-b1f1-f5ae55d5db09",
"Integration": {
"IntegrationId": "9e6c3900-3949-4007-a412-511e80954d85",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"56bb0bbd-e4f0-4aac-9e3c-86d1b830ed0b": 2.0,
"5f2f40d2-9021-4358-8e18-358fbd45aca4": 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": "0704dab4-c41e-4732-a3cf-45cdd71d4aec",
"Name": "sample string 1",
"Created": "2026-10-01T08:22:48.4843598+00:00",
"Modified": "2026-10-01T08:22:48.4843598+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"db8929f0-cddb-4c78-9f18-0773c8f37526",
"6ef0621f-f9ca-45b0-8ce8-4c3ce730fc94"
],
"NonLaborAssignments": [
{
"Id": "85a1abd7-4037-471b-b883-410d54609767",
"ResourceId": "6c29f874-a279-47eb-9802-e40d2f3c00bf",
"Quantity": 3.0
},
{
"Id": "85a1abd7-4037-471b-b883-410d54609767",
"ResourceId": "6c29f874-a279-47eb-9802-e40d2f3c00bf",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "defe6402-6349-4794-ba8f-ce80348ec768",
"Type": 0,
"ResourceId": "3fe43475-1cd7-469f-a9df-fd048abde53e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "4cc692a2-2b77-4f35-a898-b3a31297e2c4",
"Start": "2026-10-01T08:22:48.4843598+00:00",
"Due": "2026-10-01T08:22:48.4843598+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "4cc692a2-2b77-4f35-a898-b3a31297e2c4",
"Start": "2026-10-01T08:22:48.4843598+00:00",
"Due": "2026-10-01T08:22:48.4843598+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "defe6402-6349-4794-ba8f-ce80348ec768",
"Type": 0,
"ResourceId": "3fe43475-1cd7-469f-a9df-fd048abde53e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "4cc692a2-2b77-4f35-a898-b3a31297e2c4",
"Start": "2026-10-01T08:22:48.4843598+00:00",
"Due": "2026-10-01T08:22:48.4843598+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "4cc692a2-2b77-4f35-a898-b3a31297e2c4",
"Start": "2026-10-01T08:22:48.4843598+00:00",
"Due": "2026-10-01T08:22:48.4843598+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "b3fa1416-de8b-4a50-abf3-8fbbeacf031b",
"WorkTypeParentId": "f7f29ba4-d70e-4088-9cd1-63a4e40a0d2e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "fa235933-6aca-4459-b818-60bff4e8448f",
"UPN": "e7494b82-4e0b-4029-8231-02f23c220d21",
"PostDate": "2026-10-01T08:22:48.4843598+00:00",
"Comment": "sample string 4",
"CC": [
"afc664de-2c43-4ce8-813a-8c7114cfb707",
"65a2e9d5-4e90-436c-a6a5-041429fdffc0"
],
"Users": [
"6c3f4bd4-d83d-4a3a-8f16-fbbe2180cae9",
"79144d0c-0cee-4193-a2b3-f6b14e3a934a"
]
},
{
"Id": "fa235933-6aca-4459-b818-60bff4e8448f",
"UPN": "e7494b82-4e0b-4029-8231-02f23c220d21",
"PostDate": "2026-10-01T08:22:48.4843598+00:00",
"Comment": "sample string 4",
"CC": [
"afc664de-2c43-4ce8-813a-8c7114cfb707",
"65a2e9d5-4e90-436c-a6a5-041429fdffc0"
],
"Users": [
"6c3f4bd4-d83d-4a3a-8f16-fbbe2180cae9",
"79144d0c-0cee-4193-a2b3-f6b14e3a934a"
]
}
],
"StartDate": "2026-10-01T08:22:48.4843598+00:00",
"DueDate": "2026-10-01T08:22:48.4843598+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0d2376fd-d7ae-4279-bdb9-9e612ce066df": "4df479db-35d5-4a8d-81d6-71cf8dd23f59",
"705bbb22-2e70-45a9-b212-ccc30d518ec2": "3fc49142-283a-4864-a405-1567bf7400af"
},
"HasUpdates": true,
"Modified": "2026-10-01T08:22:48.4843598+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-01T08:22:48.4843598+00:00"
},
"LastComment": "2026-10-01T08:22:48.4843598+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "1b539518-8087-4a24-808a-9a2885702090",
"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": "42dc28a8-d778-4873-bc65-0b1d58763878",
"id": "889d073f-bedd-473a-9b5d-eb8cd538190b",
"ConfigId": "08f0bb08-8a7f-44e6-b9bb-5048889d5b24"
}