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": "96cecfc6-99d2-4937-9270-613a4d53ae45",
"ParentTaskId": "18992781-ade9-4c47-a7a8-00941ca5ea20",
"Integration": {
"IntegrationId": "e0e5ce44-5916-438c-9eee-5f28f522dce6",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"85a3d025-d44a-4c38-bd9a-fd74ec2711f6": 2.0,
"958a0b65-5c28-4a5a-ad51-4564c3175eb8": 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": "6a1da734-c9a0-4152-b9f9-06a936de0d3c",
"Name": "sample string 1",
"Created": "2026-10-06T21:32:47.2366397+00:00",
"Modified": "2026-10-06T21:32:47.2366397+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c91172a1-af52-46b5-882e-4972966ab38a",
"1873156a-46f9-4185-a890-6398f3d2c98b"
],
"NonLaborAssignments": [
{
"Id": "19276d1f-025d-45c3-8898-af0e661443e2",
"ResourceId": "ac4eaa83-f891-4beb-bc3c-a7110729e9c5",
"Quantity": 3.0
},
{
"Id": "19276d1f-025d-45c3-8898-af0e661443e2",
"ResourceId": "ac4eaa83-f891-4beb-bc3c-a7110729e9c5",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "543d305a-c348-4d6a-9f8e-f62ce63e585a",
"Type": 0,
"ResourceId": "98320626-47d5-4602-aedd-48365350e92c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "a11ee217-c05e-423c-95f5-719437ef7756",
"Start": "2026-10-06T21:32:47.2366397+00:00",
"Due": "2026-10-06T21:32:47.2366397+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "a11ee217-c05e-423c-95f5-719437ef7756",
"Start": "2026-10-06T21:32:47.2366397+00:00",
"Due": "2026-10-06T21:32:47.2366397+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "543d305a-c348-4d6a-9f8e-f62ce63e585a",
"Type": 0,
"ResourceId": "98320626-47d5-4602-aedd-48365350e92c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "a11ee217-c05e-423c-95f5-719437ef7756",
"Start": "2026-10-06T21:32:47.2366397+00:00",
"Due": "2026-10-06T21:32:47.2366397+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "a11ee217-c05e-423c-95f5-719437ef7756",
"Start": "2026-10-06T21:32:47.2366397+00:00",
"Due": "2026-10-06T21:32:47.2366397+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "95848e21-65bf-4d9f-9ea2-121314de9e47",
"WorkTypeParentId": "ae0517c0-40a1-4dae-9319-183eb4389d6d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f18dcc6a-e5b0-4c4e-b16e-13c431c29a9b",
"UPN": "6121a633-3685-42f4-b14a-fdfd0b2c7c15",
"PostDate": "2026-10-06T21:32:47.2366397+00:00",
"Comment": "sample string 4",
"CC": [
"0f90976f-3f2d-4d60-b78b-6e3b31fa6204",
"cedb0e8a-a02c-4f4c-a708-7dd7d2463557"
],
"Users": [
"10d32d65-c7aa-403e-985c-9e131516ec0d",
"37cced34-673c-4aac-a8b1-43479ebfd4f4"
]
},
{
"Id": "f18dcc6a-e5b0-4c4e-b16e-13c431c29a9b",
"UPN": "6121a633-3685-42f4-b14a-fdfd0b2c7c15",
"PostDate": "2026-10-06T21:32:47.2366397+00:00",
"Comment": "sample string 4",
"CC": [
"0f90976f-3f2d-4d60-b78b-6e3b31fa6204",
"cedb0e8a-a02c-4f4c-a708-7dd7d2463557"
],
"Users": [
"10d32d65-c7aa-403e-985c-9e131516ec0d",
"37cced34-673c-4aac-a8b1-43479ebfd4f4"
]
}
],
"StartDate": "2026-10-06T21:32:47.2366397+00:00",
"DueDate": "2026-10-06T21:32:47.2366397+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"231a1d26-aead-4d10-8958-54b5b8d36709": "ec1f3b73-d74d-42c7-8d55-fe49a1f154e7",
"32987dce-caa7-4af1-a5aa-209fe2e33185": "85712122-3049-4b37-8d46-e963c3a8cd34"
},
"HasUpdates": true,
"Modified": "2026-10-06T21:32:47.2366397+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-06T21:32:47.2366397+00:00"
},
"LastComment": "2026-10-06T21:32:47.2366397+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "51f813d3-2d1c-46d8-a142-7e4744473753",
"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": "87b44fe1-3968-4c6b-a47e-13a04eea9bb2",
"id": "8b5f6233-9a7a-46ff-b676-ba4af3989dde",
"ConfigId": "60723397-da77-4ffd-b1cd-4579a1facb1c"
}